AppCivist Core API API Reference
AppCivist is a software platform for democratic assembly and collective action that lets users organize Assemblies, Campaign and Working Groups as spaces for contribution and decision making
API Endpoint
http://platform.appcivist.org/Version: beta
07 files: Upload files
Upload a file and get its URL
File to upload
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
"string"
200 OK
successful operation
400 Bad Request
File upload error
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string (uuid)",
"name": "string",
"file": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Upload YML data
file
File with Data to Upload
type
file
in
formData
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
File upload error
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string (uuid)",
"name": "string",
"file": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
00 user: User Management
Get list of users
Get the full list of users. Only available to ADMINS
SESSION_KEY
User's auth key
type
string
in
header
200 OK
successful operation
400 Bad Request
Request has errors
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
GET /api/user/authenticate/{provider}/denied
provider
(no description)
type
string
in
path
200 OK
successful operation
Response Example (200 OK)
"object"
Returns a form to link external auth provider accounts
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: text/html
Response Example (200 OK)
"object"
Creates a new session key for the requesting user, if the system authenticates him/her.
User's Login Credentials
Request Example
{
"email": "string",
"password": "string"
}
200 OK
successful operation
400 Bad Request
Request has errors
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Expires the session key of the requesting user
Logout body must be empty JSON
SESSION_KEY
User's session authentication key
type
string
in
header
Request Content-Types: application/json
Request Example
"string"
200 OK
successful operation
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
Changes user's password
User's updated password form
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"oldPassword": "string",
"password": "string",
"repeatPassword": "string"
}
200 OK
successful operation
Response Content-Types: application/html
Response Example (200 OK)
"object"
Request a token to change forgot password
200 OK
successful operation
404 Not Found
User not found
Response Example (200 OK)
"object"
Changes user's password
User's updated password form
Request Example
{
"password": "string",
"repeatPassword": "string",
"token": "string"
}
200 OK
successful operation
Response Content-Types: application/html
Response Example (200 OK)
"object"
GET /api/user/password/reset/{token}
token
(no description)
type
string
in
path
200 OK
successful operation
Response Example (200 OK)
"object"
Creates a new unverified user with an email and a password. Sends a verification email.
User's signup form
Request Example
{
"email": "string",
"password": "string",
"repeatPassword": "string",
"name": "string",
"lang": "string",
"newAssembly": {
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"shortname": "string",
"description": "string",
"listed": "boolean",
"invitationEmail": "string",
"profile": {
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
},
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"organizations": [
{
"organizationId": "integer (int64)",
"title": "string",
"description": "string",
"logo": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
}
],
"themes": [
{
"title": "string",
"description": "string"
}
],
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"configs": [
{
"configId": "integer (int64)",
"key": "string",
"value": "string"
}
],
"invitations": [
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
],
"linkedAssemblies": [
null
]
}
}
200 OK
successful operation
400 Bad Request
Request has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Gets page for email verification
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User not found
Response Example (200 OK)
"object"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Verify invitation token
token
(no description)
type
string
in
path
token
Verification token
type
string
in
path
200 OK
successful operation
400 Bad Request
Error in Request
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get a user by id
Get a user by id. Only available to ADMINS
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's auth key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
Update user information
Updates user information
User's updated information
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Soft delete of an user
Soft delete of an user by simply deactivating it
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
check if user has a Facebook access token
user with id :id
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's auth key
type
string
in
header
200 OK
successful operation
404 Not Found
Facebook Token not found
Response Content-Types: application/json
Response Example (200 OK)
{
"accountId": "integer (int64)",
"user": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Stores a new facebook access token for user
user with id :id
UUID of the assembly which
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's auth key
type
string
in
header
Request Example
"string (uuid)"
200 OK
successful operation
400 Bad Request
Request has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"accountId": "integer (int64)",
"user": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update user's facebook access token
user with id :id
UUID of the assembly which
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's auth key
type
string
in
header
Request Example
"string (uuid)"
200 OK
successful operation
404 Not Found
Linked Account not found
Response Content-Types: application/json
Response Example (200 OK)
{
"accountId": "integer (int64)",
"user": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a user
Delete a user, but not his/her contributions
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get session user
Get session user currently loggedin, as available in HTTP session
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's auth key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
Get session user's profile
Get session user currently loggedin, as available in HTTP session
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's auth key
type
string
in
header
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json, text/html
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"profileId": "integer (int64)",
"uuidAsString": "string",
"name": "string",
"middleName": "string",
"lastName": "string",
"birthdate": "string (date-time)",
"address": "string",
"note": "string",
"phone": "string",
"gender": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create user's profile
User's new profile information
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"profileId": "integer (int64)",
"uuidAsString": "string",
"name": "string",
"middleName": "string",
"lastName": "string",
"birthdate": "string (date-time)",
"address": "string",
"note": "string",
"phone": "string",
"gender": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
]
}
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"profileId": "integer (int64)",
"uuidAsString": "string",
"name": "string",
"middleName": "string",
"lastName": "string",
"birthdate": "string (date-time)",
"address": "string",
"note": "string",
"phone": "string",
"gender": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update user's profile information
Updates user's profile information
User's updated profile information
uid
(no description)
type
integer
(int64)
in
path
uid
User's ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"profileId": "integer (int64)",
"uuidAsString": "string",
"name": "string",
"middleName": "string",
"lastName": "string",
"birthdate": "string (date-time)",
"address": "string",
"note": "string",
"phone": "string",
"gender": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
]
}
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
01 assembly: Assembly Making
Get list of assemblies based on query
query
Search query string (keywords in title)
type
string
in
query
filter
Special filters. 'summary' returns only summarized info of assemblies, 'featured' returns a list of marks featured assemblies and 'nearby' limits the query to assemblies that are nearby of the user location,
type
string
featured,
nearby,
summary,
random
in
query
shortname
Search by shortname
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new assembly
The templates will be used to import all the resources from a list of existing assembly to the new
Body of Assembly in JSON
templates
List of assembly ids (separated by comma) to use as template for the current assembly
type
string
in
query
invitations
Send invitations if true
type
string
false
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
{
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"shortname": "string",
"description": "string",
"listed": "boolean",
"invitationEmail": "string",
"profile": {
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
},
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"organizations": [
{
"organizationId": "integer (int64)",
"title": "string",
"description": "string",
"logo": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
}
],
"themes": [
{
"title": "string",
"description": "string"
}
],
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"configs": [
{
"configId": "integer (int64)",
"key": "string",
"value": "string"
}
],
"invitations": [
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
],
"linkedAssemblies": [
{
"assemblyId": "integer (int64)"
}
],
"linkedAssembliesIds": [
"integer (int64)"
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Upload users to assembly
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
send_invitations
Send invitations if true
type
string
false
in
query
file
CSV file
type
file
in
formData
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get list of available contribution templates in assembly
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Contribution Template Found
Response Content-Types: application/json
Response Example (200 OK)
[
"string (url)"
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new Contribution Template in an assembly
Only for COORDINATORS
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No assembly found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Confirm Contribution Template
aid
Assembly ID
type
integer
(int64)
in
path
Resource ID
Contribution Template
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution template found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete contribution template from assembly
Only for COORDINATOS of assembly
aid
Assembly ID
type
integer
(int64)
in
path
rid
Resource ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get list of linked assemblies to a single assembly
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Upload users to assembly
aid
Assembly ID
type
integer
(int64)
in
path
send_invitations
Send invitations if true
type
string
false
in
query
file
CSV file
type
file
in
formData
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get assembly profile if it is listed or if it is in the list of linked assemblies
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
{
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"shortname": "string",
"name": "string",
"profile": {
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
},
"themes": [
{
"title": "string",
"description": "string"
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Verify if user is member of an assembly
aid
Assembly ID
type
integer
(int64)
in
path
uid
User id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No membership in this group found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read Assembly by ID
Only for MEMBERS of the assembly
id
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update Assembly by ID
Only for COORDINATORS
Body of Assembly in JSON
id
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete Assembly by ID
Only for COORDINATORS
id
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new assembly in a principal assembly
Body of Assembly in JSON
id
Id of the principal assembly under which to create the new
type
integer
(int64)
in
path
templates
List of assembly ids (separated by comma) to use as template for the current assembly
type
string
in
query
invitations
Send invitations if true
type
string
false
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
{
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"shortname": "string",
"description": "string",
"listed": "boolean",
"invitationEmail": "string",
"profile": {
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
},
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"organizations": [
{
"organizationId": "integer (int64)",
"title": "string",
"description": "string",
"logo": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
}
],
"themes": [
{
"title": "string",
"description": "string"
}
],
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"configs": [
{
"configId": "integer (int64)",
"key": "string",
"value": "string"
}
],
"invitations": [
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
],
"linkedAssemblies": [
{
"assemblyId": "integer (int64)"
}
],
"linkedAssembliesIds": [
"integer (int64)"
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add membership to the assembly by listing AppCivist's users emails
Only for COORDINATORS
List of membership's form in the body including only the target's user email
id
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"first": "number",
"second": "number"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get Assembly Memberships by ID and status
Only for MEMBERS of the assembly
id
(no description)
type
integer
(int64)
in
path
status
(no description)
type
string
in
path
id
Assembly id
type
integer
(int64)
in
path
status
Status of membership invitation or request
type
object
REQUESTED,
INVITED,
FOLLOWING,
ALL
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add membership to the assembly
Only for COORDINATORS
Membership's form in body
id
Assembly ID
type
integer
(int64)
in
path
type
Type of membership
type
string
INVITATION,
REQUEST,
SUBSCRIPTION
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get list of assemblies based on query
query
Search query string (keywords in title)
type
string
in
query
filter
Special filters. 'summary' returns only summarized info of assemblies, 'featured' returns a list of marks featured assemblies and 'nearby' limits the query to assemblies that are nearby of the user location,
type
string
featured,
nearby,
summary,
random
in
query
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"shortname": "string",
"name": "string",
"profile": {
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
},
"themes": [
{
"title": "string",
"description": "string"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read Assembly by Shortname
Only for MEMBERS of the assembly
shortname
Assembly Shortname
type
string
in
path
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read Assembly by its Universal ID
uuid
Assembly UUID
type
string
in
path
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read the profile of an Assembly
uuid
Universal ID of Assembly
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update the profile of the Assembly
Body of AssemblyProfile in JSON
uuid
Universal ID of the Assembly
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean"
}
}
}
}
}
}
}
}
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get themes of an assembly by its UUID
uuid
Universal ID of Assembly
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get organizations in a resource space by the UUID of the space
uuid
Resource Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)"
}
}
}
}
}
}
}
}
]
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get organizations in a resource space
sid
Resource Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)"
}
}
}
}
}
}
}
}
]
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update organizations in a resource space
Body of Organization in JSON
sid
Resource Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a organization from resource space
sid
Resource Space ID
type
integer
(int64)
in
path
id
Organization ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
05 contribution: Contribution Making
Update Feedback on a Contribution
Feedback on a contribution is a summary of its ups/downs/favs (TBD if this endpoint will remain)
Body of Contribution Statistics in JSON
aid
Assembly ID
type
integer
(int64)
in
path
caid
Campaign ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
ASSEMBLY_ID
The real author of the post
type
string
in
header
SOCIAL_IDEATION_SOURCE
Indicates the name of the providerId
type
string
in
header
SOCIAL_IDEATION_SOURCE_URL
Source to the original post
type
string
in
header
SOCIAL_IDEATION_USER_SOURCE_ID
Email or id of the user in the source social network
type
string
in
header
SOCIAL_IDEATION_USER_SOURCE_URL
Link to the user
type
string
in
header
SOCIAL_IDEATION_USER_NAME
User name in source
type
string
in
header
IGNORE_ADMIN_USER
Boolean that indicates if AppCivist should or should not consider the ADMIN user as author
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"ups": "integer (int64)",
"downs": "integer (int64)",
"favs": "integer (int64)",
"flags": "integer (int64)",
"points": "integer (int64)",
"averageBenefit": "integer (int32)",
"averageNeed": "integer (int32)",
"averageFeasibility": "integer (int32)",
"eligibilityTrue": "integer (int32)",
"eligibilityFalse": "integer (int32)",
"type": "string"
}
200 OK
successful operation
400 Bad Request
Contribution form has errors
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"ups": "integer (int64)",
"downs": "integer (int64)",
"favs": "integer (int64)",
"flags": "integer (int64)",
"points": "integer (int64)",
"averageBenefit": "integer (int32)",
"averageNeed": "integer (int32)",
"averageFeasibility": "integer (int32)",
"eligibilityTrue": "integer (int32)",
"eligibilityFalse": "integer (int32)",
"type": "string"
}
]
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions in a component of a campaign within an assembly
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
ciid
Component ID
type
integer
(int64)
in
path
type
Type of contributions
type
string
forum_post,
comment,
idea,
question,
issue,
proposal,
note,
discussion
idea
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions in a Campaign
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
type
Type of contributions
type
string
forum_post,
comment,
idea,
question,
issue,
proposal,
note,
discussion
idea
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Export campaign ideas to a CSV file
aid
Assembly id
type
integer
(int64)
in
path
cid
Campaign id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/csv
Response Example (200 OK)
"object"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Import CSV file with campaign ideas or proposals
CSV format: the values must be separated by coma (;). If the theme column has more than one theme, then it must be separated by dash (-).
aid
Assembly id
type
integer
(int64)
in
path
cid
Campaign id
type
integer
(int64)
in
path
type
Contribution Type
type
string
IDEA,
PROPOSAL
IDEA
in
query
createThemes
Contribution Type
type
boolean
in
query
file
CSV file
type
file
in
formData
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
"object"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get the pad body url of a Contribution in a Assembly
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
coid
Contribution ID
type
integer
(int64)
in
path
rev
Revision
type
integer
(int64)
in
query
format
String
type
string
text,
html
html
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Publishes a Contribution
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
coid
Contribution ID
type
integer
(int64)
in
path
typeDocument
Type of document
type
string
etherpad
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
"integer (int32)"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions feedbacks
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
coid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution feedbacks found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get individual ContributionFeedback
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
coid
Contribution ID
type
integer
(int64)
in
path
fid
Feedback ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution feedback found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions statistics
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
coid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution stats found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"ups": "integer (int64)",
"downs": "integer (int64)",
"favs": "integer (int64)",
"flags": "integer (int64)",
"points": "integer (int64)",
"averageBenefit": "integer (int32)",
"averageNeed": "integer (int32)",
"averageFeasibility": "integer (int32)",
"eligibilityTrue": "integer (int32)",
"eligibilityFalse": "integer (int32)",
"type": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read contribution Feedback
Feedback on a contribution is a summary of its ups/downs/favs (TBD if this endpoint will remain)
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
ContributionFeedback form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get workgroup contributions statistics
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
gud
Group ID
type
integer
(int64)
in
path
coid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution stats found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"ups": "integer (int64)",
"downs": "integer (int64)",
"favs": "integer (int64)",
"flags": "integer (int64)",
"points": "integer (int64)",
"averageBenefit": "integer (int32)",
"averageNeed": "integer (int32)",
"averageFeasibility": "integer (int32)",
"eligibilityTrue": "integer (int32)",
"eligibilityFalse": "integer (int32)",
"type": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions in Assembly
aid
Assembly ID
type
integer
(int64)
in
path
space
Resource space name within assembly from which we want to query contributions
type
string
forum,
resources
forum
in
query
type
Type of contributions
type
string
forum_post,
comment,
idea,
question,
issue,
proposal,
note,
discussion
idea
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contribution by ID
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update contribution in Assembly
Body of Contribution in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
400 Bad Request
Contribution form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a contribution (will remove it from the database)
Only for ADMINS
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add an attachment to a contribution
An attachment is a RESOURCE (with an URL) added to the 'resources' resource space of a Contribution
Body of Contribution in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
400 Bad Request
Resource form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read comments on a Contribution
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create comment on contribution
Body of Contribution in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
400 Bad Request
Contribution form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read associated contributions of a Contribution
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions change history
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionHistoryId": "integer (int64)",
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"moderationComment": "string",
"budget": "string",
"actionDueDate": "string (date-time)",
"actionDone": "boolean",
"action": "string",
"assessmentSummary": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string"
}
}
}
}
}
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Contribution moderation. Soft deletes contribution
Body of Contribution in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get the pad of a Contribution
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
{
"padId": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Logical recovery of contribution Assembly
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
"string"
Logical removal of contribution in Assembly
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
"string"
Assign a contribution to a resource space
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
sid
Resource Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a contribution to a resource space
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
sid
Resource Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update status of a Contribution
aid
Assembly ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
status
New Status for the Contribution
type
string
NEW,
PUBLISHED,
EXCLUDED,
ARCHIVED
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
500 Internal Server Error
Status not valid
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get Contribution Feedbacks
aid
Assembly ID
type
integer
(int64)
in
path
coid
Contribution ID
type
integer
(int64)
in
path
type
Type
type
string
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution feedbacks found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response status
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create Assembly forum post
An Assembly Forum POST is a contribution of type FORUM_POST in the 'forum' resource space of an Assembly
Body of Contribution in JSON
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
400 Bad Request
Contribution form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions in a Working Group
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
space
Resource space name within the working group from which we want to query contributions
type
string
forum,
resources
forum
in
query
type
Type of contributions
type
string
forum_post,
comment,
idea,
question,
issue,
proposal,
note,
discussion
idea
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create contributions in the Working Group of an Assembly
Body of Contribution in JSON
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
space
Resource Space within Working Group
type
string
resources,
forum
resources
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
400 Bad Request
Contribution form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get Contribution Feedbacks
aid
Assembly ID
type
integer
(int64)
in
path
gid
Group ID
type
integer
(int64)
in
path
coid
Contribution ID
type
integer
(int64)
in
path
type
Type
type
string
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution feedbacks found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Crete forum post in Working Group
A forum post is a contribution of type FORUM_POST in the the 'forum' resource space of the Working Group
Body of Contribution in JSON
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
400 Bad Request
Contribution form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Archives duplicated feedbacks
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete duplicate contributions change history
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Generates histories for all contributions
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update all contribution languages
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
500 Internal Server Error
Status not valid
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new propolsal from contribution template
aid
Assembly ID
type
string
in
query
cid
Contribution ID
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new Campaign
rid
Resource (that represents that PAD) ID
type
integer
(int64)
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get the pad body url of a Contribution
couuid
Contribution UUID
type
string
(uuid)
in
path
rev
Revision
type
integer
(int64)
in
query
format
String
type
string
text,
html
html
in
query
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add themes to a contribution
Themes to add to the contribution
uuid
Contribution's Universal Id (UUID)
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"themes": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
}
200 OK
successful operation
400 Bad Request
Theme form has errors
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add a theme to a contribution
Themes to add to the contribution
uuid
Contribution's Universal Id (UUID)
type
string
(uuid)
in
path
tid
Theme's Id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"themes": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
}
200 OK
successful operation
400 Bad Request
Contribution form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List contributions
page
Page to retrieve
type
string
1
in
query
by_uuid
Filter contributions by UUID
type
string
in
query
by_theme_id
Filter contributions by theme
type
string
in
query
200 OK
List of contributions
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
{
"pageSize": "integer (int32)",
"totalCount": "integer (int32)",
"results": [
"number"
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create anonymous contribution in Assembly
Body of Contribution in JSON
uuid
Universal ID of the target contribution
type
string
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
500 Internal Server Error
Status not valid
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update Feedback on a Contribution
Feedback on a contribution is a summary of its ups/downs/favs (TBD if this endpoint will remain)
Body of Contribution Feedback in JSON
cuuid
Campaign UUID
type
string
(uuid)
in
path
uuid
Contribution UUID
type
string
(uuid)
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
200 OK
successful operation
400 Bad Request
Contribution feedback form has errors
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
]
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create an anonymous contribution in a campaign
Body of Contribution in JSON
uuid
Universal ID of the target campaign
type
string
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
500 Internal Server Error
Status not valid
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get Contribution Feedbacks
couuid
Contribution UUID
type
string
in
path
type
Type
type
string
null
in
query
200 OK
successful operation
404 Not Found
No contribution feedbacks found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contribution by its Universal ID
uuid
Contribution Universal ID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create an anonymous contribution within another contribution
Body of Contribution in JSON
uuid
Universal ID of the target contribution
type
string
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
500 Internal Server Error
Error creating contribution
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contribution histories by its Universal ID
uuid
Contribution Universal ID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No contribution histories found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionHistoryId": "integer (int64)",
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"moderationComment": "string",
"budget": "string",
"actionDueDate": "string (date-time)",
"actionDone": "boolean",
"action": "string",
"assessmentSummary": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string"
}
}
}
}
}
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create an anonymous contribution in a working group
Body of Contribution in JSON
uuid
Universal ID of the target working group
type
string
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
500 Internal Server Error
Status not valid
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contribution by its Universal Resource Space ID
uuid
Resource Space Universal ID
type
string
(uuid)
in
path
type
Type of contributions
type
string
forum_post,
comment,
idea,
question,
issue,
proposal,
note
in
query
by_text
String
type
string
in
query
groups
List
format
multiple parameters (
groups=aaa&groups=bbb)type
integer[]
null
in
query
themes
List
format
multiple parameters (
themes=aaa&themes=bbb)type
integer[]
null
in
query
all
Boolean
type
string
null
in
query
page
Page
type
integer
(int32)
in
query
pageSize
Number of elements per page
type
integer
(int32)
null
in
query
sorting
Ordering of proposals
type
string
in
query
random
Boolean
type
string
null
in
query
status
Status of Contributions
type
string
in
query
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create an anonymous contribution in a campaign
Body of Contribution in JSON
uuid
Universal ID of the target campaign
type
string
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
500 Internal Server Error
Status not valid
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contribution by its Universal Resource Space ID
uuid
Resource Space Universal ID
type
string
(uuid)
in
path
type
Type of contributions
type
string
forum_post,
comment,
idea,
question,
issue,
proposal,
note
in
query
200 OK
successful operation
404 Not Found
No contribution found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions in a specific Resource Space
Every entity in AppCivist has a Resource Space to associate itself to other entities
sid
Resource Space ID
type
integer
(int64)
in
path
type
Type of contributions
type
string
forum_post,
comment,
idea,
question,
issue,
proposal,
note
in
query
by_text
String
type
string
in
query
groups
List
format
multiple parameters (
groups=aaa&groups=bbb)type
integer[]
null
in
query
themes
List
format
multiple parameters (
themes=aaa&themes=bbb)type
integer[]
null
in
query
all
Boolean
type
string
null
in
query
by_author
Author ID
type
integer
(int32)
null
in
query
page
Page
type
integer
(int32)
in
query
pageSize
Number of elements per page
type
integer
(int32)
null
in
query
sorting
Ordering of proposals
type
string
in
query
random
Boolean
type
string
null
in
query
status
String
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a contribution in a specific Resource Space
Body of Contribution in JSON
sid
Resource Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
ASSEMBLY_ID
The real author of the post
type
string
in
header
SOCIAL_IDEATION_SOURCE
Indicates the name of the providerId
type
string
in
header
SOCIAL_IDEATION_SOURCE_URL
Source to the original post
type
string
in
header
SOCIAL_IDEATION_USER_SOURCE_ID
Email or id of the user in the source social network
type
string
in
header
SOCIAL_IDEATION_USER_SOURCE_URL
Link to the user
type
string
in
header
SOCIAL_IDEATION_USER_NAME
User name in source
type
string
in
header
IGNORE_ADMIN_USER
Boolean that indicates if AppCivist should or should not consider the ADMIN user as author
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
400 Bad Request
Contribution form has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update comment counts on contributions
Only for ADMINS
sid
Resource Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
500 Internal Server Error
Status not valid
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contributions in a specific Resource Space
Every entity in AppCivist has a Resource Space to associate itself to other entities
sid
Resource Space ID
type
integer
(int64)
in
path
type
Type of contributions
type
string
forum_post,
comment,
idea,
question,
issue,
proposal,
note
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No contributions found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Contribution containing the given word
sid
Resource Space ID
type
integer
(int64)
in
path
byText
Text to be search in the title or text of contributions
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of words in proposals or ideas from a given resource space with its frequency
sid
Resource Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
"object"
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get contribution by id in a specific Resource Space
Every entity in AppCivist has a Resource Space to associate itself to other entities
sid
Resource Space ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Export proposal list from a resource space to a CSV/RTF/PDF file
sid
Space id
type
integer
(int64)
in
path
format
Export format
type
string
PDF,
RTF,
CSV
in
query
include
Contribution fields to include
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
"object"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Export proposal to a CSV/RTF/PDF file
sid
Space id
type
integer
(int64)
in
path
cid
Contribution id
type
integer
(int64)
in
path
format
Export format
type
string
PDF,
RTF,
CSV
in
query
include
Contribution fields to include
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No proposal found
Response Example (200 OK)
"object"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Assign a resouce space to other resource space
sid
Resource Space ID
type
integer
(int64)
in
path
new_sid
New Resource Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of words in contributions from a given resource space with its frequency
sid
Resource Space ID
type
integer
(int64)
in
path
type
Type of contributions
type
string
PROPOSAL,
IDEA,
DISCUSSION,
PROPOSAL_AND_IDEAS,
ALL
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
"object"
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
09 space: resource space management
Update a Contribution description by its UUID and the space UUID
Contribution in json
suuid
Space UUID
type
string
(uuid)
in
path
cuuid
Contribution UUID
type
string
(uuid)
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
404 Not Found
No Contribution found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Contribution by UUID from a resource space
suuid
Space UUID
type
string
(uuid)
in
path
cuuid
Contribution UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No Contribution found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Simple search of resource space
uuid
(no description)
type
string
(uuid)
in
path
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
"object"
Basic analytics of entities in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
includeThemes
Include analytics of contributions per theme
type
string
false,
true
false
in
query
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"nodeType": "string",
"float": "boolean",
"valueNode": "boolean",
"binary": "boolean",
"containerNode": "boolean",
"missingNode": "boolean",
"object": "boolean",
"pojo": "boolean",
"number": "boolean",
"integralNumber": "boolean",
"floatingPointNumber": "boolean",
"short": "boolean",
"int": "boolean",
"long": "boolean",
"double": "boolean",
"bigDecimal": "boolean",
"bigInteger": "boolean",
"textual": "boolean",
"boolean": "boolean",
"array": "boolean",
"null": "boolean"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of assemblies in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of ballots in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
status
Status of ballots
type
string
active,
archived
in
query
starts_at
String Date with format ddMMyyyy
type
string
""
in
query
ends_at
String Date with format ddMMyyyy
type
string
in
query
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of campaigns in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Number of CONTRIBUTIONS of type COMMENT in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"nodeType": "string",
"float": "boolean",
"valueNode": "boolean",
"binary": "boolean",
"containerNode": "boolean",
"missingNode": "boolean",
"object": "boolean",
"pojo": "boolean",
"number": "boolean",
"integralNumber": "boolean",
"floatingPointNumber": "boolean",
"short": "boolean",
"int": "boolean",
"long": "boolean",
"double": "boolean",
"bigDecimal": "boolean",
"bigInteger": "boolean",
"textual": "boolean",
"boolean": "boolean",
"array": "boolean",
"null": "boolean"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of components in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
]
}
}
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of custom field definition in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
CustomFieldValue containing the given word
uuid
Resource Space UUID
type
string
(uuid)
in
path
fid
Custom Field Definition ID
type
integer
(int64)
in
path
etype
Entity Target Type
type
string
in
path
value
Text to be search in the value of custom field values
type
string
in
query
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of custom field value in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a custom field value in a resource space
Body of CustomFieldValue in JSON
uuid
Space UUID
type
string
(uuid)
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a list of custom field values in a resource space
Body of ResourceSpace with CustomFieldValues in JSON
uuid
Space UUID
type
string
(uuid)
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
]
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of groups in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of milestones in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentMilestoneId": "integer (int64)",
"title": "string",
"key": "string",
"position": "integer (int32)",
"description": "string",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"mainContributionType": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of themes in a resource space
uuid
Space UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Simple search of resource space
sid
(no description)
type
integer
(int64)
in
path
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
"object"
Lists resource space's assemblies
sid
ResourceSpace ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Assembly in a resource space
sid
ResourceSpace ID
type
integer
(int64)
in
path
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a Assembly by its ID and the space ID
Only for COORDINATORS
Assembly in json
sid
Space ID
type
integer
(int64)
in
path
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No Assembly found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Assembly from a resource space
sid
Space ID
type
integer
(int64)
in
path
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Assembly found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of ballots in a resource space
sid
Space ID
type
integer
(int64)
in
path
status
Status of ballots
type
string
active,
archived
in
query
starts_at
String Date with format ddMMyyyy
type
string
""
in
query
ends_at
String Date with format ddMMyyyy
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a ballot in a resource space
Body of BallotTransfer in JSON
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"component": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)"
}
]
}
}
}
]
}
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a ballot in a resource space
Body of Ballot in JSON
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Ballot by id in a resource space
sid
Space ID
type
integer
(int64)
in
path
bid
Ballot ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Ballot from a resource space
sid
Space ID
type
integer
(int64)
in
path
bid
Ballot ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Ballot found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists resource space's Campaigns
sid
ResourceSpace ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Campaign in a resource space
sid
ResourceSpace ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a Campaign by its ID and the space ID
Only for COORDINATORS
Campaign in json
sid
Space ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
200 OK
successful operation
404 Not Found
No Campaign found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Campaign from a resource space
sid
Space ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Campaign found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Comment count of a resource space
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"nodeType": "string",
"float": "boolean",
"valueNode": "boolean",
"binary": "boolean",
"containerNode": "boolean",
"missingNode": "boolean",
"object": "boolean",
"pojo": "boolean",
"number": "boolean",
"integralNumber": "boolean",
"floatingPointNumber": "boolean",
"short": "boolean",
"int": "boolean",
"long": "boolean",
"double": "boolean",
"bigDecimal": "boolean",
"bigInteger": "boolean",
"textual": "boolean",
"boolean": "boolean",
"array": "boolean",
"null": "boolean"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists resource space's components
sid
ResourceSpace ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
]
}
}
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Component in a resource space
sid
ResourceSpace ID
type
integer
(int64)
in
path
cid
Component ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
]
}
}
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a Component description by its ID and the space ID
Only for COORDINATORS
Component in json
sid
Space ID
type
integer
(int64)
in
path
cid
Component ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
]
}
}
}
]
}
200 OK
successful operation
404 Not Found
No Component found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
]
}
}
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Component from a resource space
sid
Space ID
type
integer
(int64)
in
path
cid
Component ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Component found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
]
}
}
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a config description by its ID and the space ID
Only for COORDINATORS
Config in json
sid
Space ID
type
integer
(int64)
in
path
uuid
Config UUID
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
200 OK
successful operation
404 Not Found
No config found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Config from a resource space
sid
Space ID
type
integer
(int64)
in
path
uuid
Config UUID
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Config found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a Contribution description by its ID and the space ID
Only for Members
Contribution in json
sid
Space ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
200 OK
successful operation
404 Not Found
No Contribution found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Contribution from a resource space
sid
Space ID
type
integer
(int64)
in
path
cid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Contribution found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of custom field definition in a resource space
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a custom field definition in a resource space
Body of CustomFieldDefinition in JSON
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a custom field definition in a resource space
Body of CustomFieldDefinition in JSON
sid
Space ID
type
integer
(int64)
in
path
cfid
Custom field definition ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a custom field definition from a resource space
sid
Space ID
type
integer
(int64)
in
path
cfid
Custom field definition ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
CustomFieldValue containing the given word
sid
Resource Space ID
type
integer
(int64)
in
path
fid
Custom Field Definition ID
type
integer
(int64)
in
path
etype
Entity Target Type
type
string
in
path
value
Text to be search in the value of custom field values
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List of custom field value in a resource space
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a custom field value in a resource space
Body of CustomFieldValue in JSON
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a custom field value in a resource space
Body of CustomFieldValue in JSON
sid
Space ID
type
integer
(int64)
in
path
cfid
Custom field value ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a custom field value from a resource space
sid
Space ID
type
integer
(int64)
in
path
cfid
Custom field value ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a list of custom field values in a resource space
Body of ResourceSpace with CustomFieldValues in JSON
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
]
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a list of custom field values in a resource space
Body of ResourceSpace with CustomFieldValues in JSON
sid
Space ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
]
}
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists resource space's groups
sid
ResourceSpace ID
type
integer
(int64)
in
path
is_topic
Filter by topic default true
type
string
true
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
WorkingGroup in a resource space
sid
ResourceSpace ID
type
integer
(int64)
in
path
gid
WorkingGroup ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a Working Group by its ID and the space ID
Only for COORDINATORS
WorkingGroup in json
sid
Space ID
type
integer
(int64)
in
path
gid
WorkingGroup ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No WorkingGroup found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a WorkingGroup from a resource space
sid
Space ID
type
integer
(int64)
in
path
gid
WorkingGroup ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No WorkingGroup found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get themes stats in a specific Resource Space
sid
Resource Space ID
type
integer
(int64)
in
path
type
String
type
string
OFFICIAL_PRE_DEFINED,
EMERGENT,
ALL
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists resource space's component milestones
sid
ResourceSpace ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentMilestoneId": "integer (int64)",
"title": "string",
"key": "string",
"position": "integer (int32)",
"description": "string",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"mainContributionType": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Component Milestone in a resource space
sid
ResourceSpace ID
type
integer
(int64)
in
path
mid
Component Milestone ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentMilestoneId": "integer (int64)",
"title": "string",
"key": "string",
"position": "integer (int32)",
"description": "string",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"mainContributionType": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a ComponentMilestone description by its ID and the space ID
Only for COORDINATORS
ComponentMilestone in json
sid
Space ID
type
integer
(int64)
in
path
mid
ComponentMilestone ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentMilestoneId": "integer (int64)",
"title": "string",
"key": "string",
"position": "integer (int32)",
"description": "string",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"mainContributionType": "string"
}
200 OK
successful operation
404 Not Found
No ComponentMilestone found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentMilestoneId": "integer (int64)",
"title": "string",
"key": "string",
"position": "integer (int32)",
"description": "string",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"mainContributionType": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Component Milestone from a resource space
sid
Space ID
type
integer
(int64)
in
path
mid
Component Milestone ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Component Milestone found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentMilestoneId": "integer (int64)",
"title": "string",
"key": "string",
"position": "integer (int32)",
"description": "string",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"mainContributionType": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a Resource by its ID and the space ID
Only for COORDINATORS
Resource in json
sid
Space ID
type
integer
(int64)
in
path
rid
Resource ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No Resource found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Resource from a resource space
sid
Space ID
type
integer
(int64)
in
path
rid
Resource ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Resource found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists resource space's themes
sid
ResourceSpace ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Theme in a resource space
sid
ResourceSpace ID
type
integer
(int64)
in
path
tid
Theme ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a Theme by its ID and the space ID
Only for COORDINATORS
Theme in json
sid
Space ID
type
integer
(int64)
in
path
tid
Theme ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
200 OK
successful operation
404 Not Found
No Theme found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete a Theme from a resource space
sid
Space ID
type
integer
(int64)
in
path
tid
Theme ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Theme found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
04 membership: Membership management (for assemblies and working groups)
Create a membership with any desired status within an Assembly or a Group. Endpoint available only to ADMINS.
The membership to create
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
200 OK
successful operation
202 Accepted
Membership was created
400 Bad Request
Membership body has errors
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Response Example (202 Accepted)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create and send an Invitation to join an Assembly
Only available to COORDINATORS
Invitation details
aid
Assembly Id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
Read membership record of an user within a specified assembly
aid
Assembly Id
type
integer
(int64)
in
path
uid
User Id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
Membership found
404 Not Found
Membership not found
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create and send an invitation to join a Group to a non-AppCivist user
gid
Working Group Id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
Read membership record of a user within a group
Only available to COORDINATORS
gid
Working Group Id
type
integer
(int64)
in
path
uid
User's id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
Membership found
404 Not Found
Membership not found
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a membership request for an Assembly or a Group
A membership simplified object with details of the target assembly or group and the user requesting membership
targetId
ID of the target Assembly or Group
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Resend invitation
iid
(no description)
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
iid
Invitation id
type
integer
(int64)
in
path
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
Get the list of invitations to the target Group or Assembly
targetType
group or assembly
type
string
in
path
targetId
Working Group or Assembly Id
type
integer
(int64)
in
path
status
Invitation Status
type
string
INVITED,
ACCEPTED,
REJECTED
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
202 Accepted
Invitations found
404 Not Found
Invitations not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"email": "string",
"userId": "integer (int64)",
"status": "string",
"token": {
"id": "integer (int64)",
"token": "string",
"targetUser": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
}
}
}
}
}
]
Response Example (202 Accepted)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"email": "string",
"userId": "integer (int64)",
"status": "string",
"token": {
"id": "integer (int64)",
"token": "string",
"targetUser": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read an invitation by Token
token
Invitation Token
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"email": "string",
"userId": "integer (int64)",
"status": "string",
"token": {
"id": "integer (int64)",
"token": "string",
"targetUser": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
}
}
}
}
}
Update invitation status
token
Invitation token
type
string
(uuid)
in
path
answer
Answer to the Invitation
type
string
ACCEPT,
REJECT
in
path
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
"string"
Read user memberships by User ID and Membership TYPE
This endpoint is only accessible to ADMIN users and to the User identified by the provided UUID
uid
User's ID
type
integer
(int64)
in
path
type
Type of memberships to read
type
string
assembly,
group
in
query
by_assembly
AssemblyId
type
integer
(int64)
-1
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User or Memberships not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get configs of assemblies or wgs to which the user belongs
uid
User ID
type
integer
(int64)
in
path
type
Type of memberships to read
type
string
assembly,
group
ASSEMBLY
in
query
uid
User ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read a membership record by its ID
id
Membership ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Delete a MEMBERSHIP
Only for COORDINATORS and the User of the membership
id
Membership ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read roles assigned to a specific membership record by its ID
id
Membership ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
[
{
"roleId": "integer (int64)",
"name": "string"
}
]
Add a role to a membership identified by its ID
Only for COORDINATORS
id
Membership ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Delete a role from a membership identified by its ID
Only for COORDINATORS
id
Membership ID
type
integer
(int64)
in
path
rid
Role ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Verify a MEMBERSHIP
Only for COORDINATORS and the User of the membership
id
Membership ID
type
integer
(int64)
in
path
token
Membership invitation token
type
string
in
path
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update status of a MEMBERSHIP
Only for COORDINATORS
id
Membership ID
type
integer
(int64)
in
path
status
New Membership Status
type
string
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
03 campaign: Campaign Management
List campaigns of an Assembly
aid
Assembly ID
type
integer
(int64)
in
path
filter
Filter campaign by status (ongoing, past, upcoming, all)
type
string
ongoing,
past,
future,
all
ongoing
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new Campaign
Only for COORDINATORS. The templates will be used to import all the resources from a list of existing campaigns to the new
Campaign in json
aid
Assembly ID
type
integer
(int64)
in
path
templates
List of campaign ids (separated by comma) to use as template for the current campaign
type
string
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"listed": "boolean",
"currentBallot": "string (uuid)",
"cover": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
},
"components": [
{
"componentId": "integer (int64)",
"title": "string",
"description": "string",
"key": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"milestones": [
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
],
"deletedMilestones": [
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
],
"contributions": [
{
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"budget": "string",
"authors": [
"object"
]
}
]
}
]
}
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
{
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"listed": "boolean",
"currentBallot": "string (uuid)",
"cover": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
},
"components": [
{
"componentId": "integer (int64)",
"title": "string",
"description": "string",
"key": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"milestones": [
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
],
"deletedMilestones": [
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
],
"contributions": [
{
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"budget": "string",
"authors": [
"object"
]
}
]
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read campaign by campaign and assembly IDs
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a campaign by its ID and the assembly ID
Only for COORDINATORS
Campaign in json
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete campaign by campaign and assembly IDs
Only for COORDINATOS of assembly
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's components
Only for COORDINATORS
The new Resource in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
]
}
}
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get list of available campaign templates
Get list of available campaign templates
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Campaign Template Found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new Contribution Template for the campaign
Only for COORDINATORS
Template Body Text
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
"string"
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Confirm Contribution Template
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
Resource ID
Contribution Template
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete campaign cotribution template
Only for COORDINATOS of assembly
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
rid
Resource ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a campaign description by its ID and the assembly ID
Only for COORDINATORS
Campaign in json
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update a group description by its ID
Only for COORDINATORS
Group in json
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
gid
Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's working groups
Only for COORDINATORS
The new Resource in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new Resource for the campaign
Only for COORDINATORS
The new Resource in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's resources
Only for COORDINATORS
The new Resource in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's themes
Only for COORDINATORS
The new Resource in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
themeType
String
type
string
null
in
query
query
String
type
string
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's timeline
Only for COORDINATORS
The new Resource in JSON
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string"
}
}
}
]
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get list of available campaign templates
Get list of available campaign templates
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Campaign Template Found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignTemplateId": "integer (int64)",
"nameKey": "string",
"name": "string",
"defComponents": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
]
}
}
]
}
}
]
}
}
]
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Given an Assembly Universal ID (uuid), return its campaigns
Only for MEMBERS of the assembly
uuid
Assembly's Universal ID
type
string
(uuid)
in
path
filter
Filter campaign by status (ongoing, past, upcoming, all)
type
string
ongoing,
past,
future,
all
ongoing
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
Campaigns not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read campaign by voting ballot Universal ID
uuid
Ballot Universal ID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"title": "string",
"shortname": "string",
"goal": "string",
"configs": [
{
"configId": "integer (int64)",
"key": "string",
"value": "string"
}
],
"themes": [
{
"title": "string",
"description": "string"
}
],
"workingGroups": [
{
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"profile": {
"workingGroupProfileId": "integer (int64)",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string"
},
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"resourcesResourceSpaceId": "integer (int64)",
"forumResourceSpaceId": "integer (int64)",
"resourcesResourceSpaceUUID": "string",
"forumResourceSpaceUUID": "string",
"topic": "boolean"
}
],
"timelineEdges": {
"edgeId": "integer (int64)",
"fromComponent": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
}
}
]
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read campaign by Universal ID
uuid
Campaign Universal ID (UUID)
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
]
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Public endpoint for reading campaign's html/svg brief
uuid
Campaign UUID
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Brief Found
Response Example (200 OK)
{
"brief": "string",
"campaignUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's components
Public View
The new Resource in JSON
uuid
Campaign UUID
type
string
(uuid)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
]
}
}
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's working groups
Public view
The new Resource in JSON
uuid
Campaign UUID
type
string
(uuid)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's resources
Public View
The new Resource in JSON
uuid
Campaign UUID
type
string
(uuid)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's themes
Public View
The new Resource in JSON
uuid
Campaign UUID
type
string
(uuid)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists campaign's timeline
Public view
The new Resource in JSON
uuid
Campaign UUID
type
string
(uuid)
in
path
all
Boolean
type
string
null
in
query
page
Integer
type
integer
(int32)
in
query
pageSize
Integer
type
integer
(int32)
null
in
query
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No campaign found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string"
}
}
}
]
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists resource space's resources
uuid
ResourceSpace UUID
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add a resource to resource space
The new Resource in JSON
uuid
ResourceSpace UUID
type
string
(uuid)
in
path
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Lists resource space's resources
sid
ResourceSpace ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add a resource to resource space
The new Resource in JSON
sid
ResourceSpace ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Resource in a resource space
sid
ResourceSpace ID
type
integer
(int64)
in
path
rid
Resource ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get list of default templates
Get list of default templates
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Default Template Found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
]
}
}
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get list of default templates
Get list of default templates
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Default Template Found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
]
}
}
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get list of default templates
Get list of default templates
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Default Template Found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
]
}
}
}
]
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Given a users local ID (uid), returns an array of campaigns that are organized by that user's assemblies
Only for SELF
uid
User's ID
type
integer
(int64)
in
path
filter
Filter campaign by status (ongoing, past, upcoming, all)
type
string
ongoing,
past,
future,
all
ongoing
in
query
assembly
Assembly ID
type
integer
(int64)
-1
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Campaign Found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Given a users universal ID (uuid), returns an array of campaigns that are organized by that user's assemblies
Only for SELF
uuid
User's Universal ID
type
string
(uuid)
in
path
filter
Filter campaign by status (ongoing, past, upcoming, all)
type
string
ongoing,
past,
future,
all
ongoing
in
query
assembly
Assembly UUID
type
string
(uuid)
null
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No Campaign Found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
]
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
06 notification: Notifications management
POST /api/notification/events/{type}
type
(no description)
type
string
in
path
200 OK
successful operation
Response Example (200 OK)
"object"
Get space notifications inbox
Get space notifications inbox
sid
Resource Space ID
type
integer
(int64)
in
path
page
Page
type
integer
(int32)
in
query
pageSize
Number of elements per page
type
integer
(int32)
-1
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"type": "string",
"resourceType": "string",
"containerType": "string",
"title": "string",
"text": "string",
"resourceSummary": "string",
"resourceId": "integer (int64)",
"resourceUUID": "string (uuid)",
"containerId": "integer (int64)",
"containerUUID": "string (uuid)",
"date": "string (date-time)",
"lang": "string",
"relativeUrl": "string",
"resource": "object",
"container": "object"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List notification events to which the user is subscribed
SESSION_KEY
User's session authentication key
type
string
in
header
successful operation
500 Internal Server Error
Errors in the server
Response Content-Types: application/json
Response Example (200 OK)
[
{
"eventId": "string",
"alertEndpoint": "string",
"endpointType": "string",
"origin": "string (uuid)",
"eventName": "string"
}
]
Response Example (500 Internal Server Error)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Subscribe to receive notifications for eventName on origin
Body of Subscription in JSON. Only origin and eventName needed
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"userId": "string",
"spaceId": "string",
"spaceType": "string",
"subscriptionType": "string",
"newsletterFrecuency": "integer (int32)",
"ignoredEvents": "object",
"disabledServices": "object",
"defaultService": "integer (int32)",
"defaultIdentity": "integer (int32)"
}
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Unsubscribe to stop receiving notifications for eventName on origin
origin
(no description)
type
string
(uuid)
in
path
eventName
(no description)
type
string
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Subscribe to receive notifications for events in resource space
sid
(no description)
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Unsubscribe to receive notifications for events in resource space
sid
(no description)
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
400 Bad Request
Errors in the form
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update user information
Updates user information
uuid
(no description)
type
string
(uuid)
in
path
uuid
User's UUID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"type": "string",
"resourceType": "string",
"containerType": "string",
"title": "string",
"text": "string",
"resourceSummary": "string",
"resourceId": "integer (int64)",
"resourceUUID": "string (uuid)",
"containerId": "integer (int64)",
"containerUUID": "string (uuid)",
"date": "string (date-time)",
"lang": "string",
"relativeUrl": "string",
"resource": "object",
"container": "object"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get notifications by user
Get notifications by user
id
User ID
type
integer
(int64)
in
path
page
Page
type
integer
(int32)
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"type": "string",
"resourceType": "string",
"containerType": "string",
"title": "string",
"text": "string",
"resourceSummary": "string",
"resourceId": "integer (int64)",
"resourceUUID": "string (uuid)",
"containerId": "integer (int64)",
"containerUUID": "string (uuid)",
"date": "string (date-time)",
"lang": "string",
"relativeUrl": "string",
"resource": "object",
"container": "object"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update user notifications
Update user notifications
id
User ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
Notification not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"read": "boolean",
"signal": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"spaceType": "string",
"signalType": "string",
"eventId": "string",
"title": "string",
"text": "string",
"data": "object"
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get notifications stats by user
Get notifications stats by user
id
User ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"resourceType": "string",
"containerType": "string",
"title": "string",
"text": "string",
"resourceSummary": "string",
"resourceId": "integer (int64)",
"resourceUUID": "string (uuid)",
"containerId": "integer (int64)",
"containerUUID": "string (uuid)",
"date": "string (date-time)",
"lang": "string",
"relativeUrl": "string",
"resource": "object",
"container": "object"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update user notification
Update user notification
id
User ID
type
integer
(int64)
in
path
nid
ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
Notification not found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"read": "boolean",
"signal": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"spaceType": "string",
"signalType": "string",
"eventId": "string",
"title": "string",
"text": "string",
"data": "object"
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
10 configuration: configuration management
GET /api/assembly/{aid}/config
aid
(no description)
type
integer
(int64)
in
path
200 OK
successful operation
Response Example (200 OK)
"object"
Add configuration to the assembly
If assembly is coordinated, only COORDINATORS can access this encpoint
configuration details in body
aid
(no description)
type
integer
(int64)
in
path
id
Assembly id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
200 OK
successful operation
404 Not Found
No assembly found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
GET /api/assembly/{aid}/config/{cid}
aid
(no description)
type
integer
(int64)
in
path
cid
(no description)
type
string
in
path
200 OK
successful operation
Response Example (200 OK)
"object"
PUT /api/assembly/{aid}/config/{cid}
aid
(no description)
type
integer
(int64)
in
path
cid
(no description)
type
string
in
path
200 OK
successful operation
Response Example (200 OK)
"object"
DELETE /api/assembly/{aid}/config/{cid}
aid
(no description)
type
integer
(int64)
in
path
cid
(no description)
type
string
in
path
200 OK
successful operation
Response Example (200 OK)
"object"
Get configs in a Resource Space
uuid
(no description)
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
"object"
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get configs in a Resource Space
sid
(no description)
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
[
"object"
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add configuration to the resource space
configuration key value json map
sid
(no description)
type
integer
(int64)
in
path
sid
Resource Space id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
"string"
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update configs in a Resource Space
configuration key value json map
sid
(no description)
type
integer
(int64)
in
path
sid
Resource Space id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
"string"
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get config by id in a Resource Space
sid
(no description)
type
integer
(int64)
in
path
uuid
(no description)
type
string
(uuid)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get user configs
configuration key value json map
aid
(no description)
type
integer
(int64)
in
path
sid
Resource Space id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
"string"
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update user configs
configuration key value json map
aid
(no description)
type
integer
(int64)
in
path
sid
Resource Space id
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
"string"
200 OK
successful operation
404 Not Found
No resource space found
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
02 group: Working Group Management
List of groups created in a campaign
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a Working Group in the Campaign identified by ID
This will also add the Working Gorup to the Assembly organizing this campaign. Only for COORDINATORS
New Working Group in json
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
invitations
Send invitations if true
type
string
false
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
400 Bad Request
Group create error
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Assigns contributions to the working group
aid
Assembly ID
type
integer
(int64)
in
path
cid
Campaign ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List groups of an assembly
aid
Assembly ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Create a new working group
Only for COORDINATORS
New Working Group in json
aid
Assembly ID
type
integer
(int64)
in
path
invitations
Send invitations if true
type
string
false
in
query
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
400 Bad Request
group create error
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
List groups with specific location name
aid
Assembly ID
type
integer
(int64)
in
path
location_name
Location Name
type
string
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get working group by ID
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Update Working Group by ID
Only for COORDINATORS
New Working Group in json
aid
Assembly ID
type
integer
(int64)
in
path
aid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
200 OK
successful operation
400 Bad Request
Group create error
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Delete group by ID
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No campaign found
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Creates new Consensus Ballot from selected/remaining proposals in working group
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Creates new Consensus Ballot from selected/remaining proposals in working group
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get working group CONTRIBUTIONS
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get working group PROPOSALS
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)"
}
]
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Publishes a Contribution
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
pid
Contribution ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
"integer (int32)"
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get Working Group Memberships by user ID
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
uid
User ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
User is not Member of Group
Response Content-Types: application/json
Response Example (200 OK)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get Working Group Memberships by ID and status
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
status
Status of membership invitation or request
type
string
REQUESTED,
INVITED,
FOLLOWING,
ALL
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No membership in this group found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
]
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Add membership to the working group
Only for COORDINATORS
membership's form in body
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
Type
Type of Membership
type
string
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
200 OK
successful operation
400 Bad Request
mebership create error
Response Content-Types: application/json
Response Example (200 OK)
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
Response Example (400 Bad Request)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Get working group profile if it is listed
aid
Assembly ID
type
integer
(int64)
in
path
gid
Working Group ID
type
integer
(int64)
in
path
SESSION_KEY
User's session authentication key
type
string
in
header
200 OK
successful operation
404 Not Found
No group found
Response Content-Types: application/json
Response Example (200 OK)
{
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"profile": {
"workingGroupProfileId": "integer (int64)",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string"
},
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"resourcesResourceSpaceId": "integer (int64)",
"forumResourceSpaceId": "integer (int64)",
"resourcesResourceSpaceUUID": "string",
"forumResourceSpaceUUID": "string",
"topic": "boolean"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Read working group by Universal ID
uuid
Working Group Universal ID (UUID)
type
string
(uuid)
in
path
200 OK
successful operation
404 Not Found
No working group found
Response Content-Types: application/json
Response Example (200 OK)
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
08: Other
API Swagger-UI documentation
200 OK
successful operation
Response Content-Types: text/html
Response Example (200 OK)
"object"
Log an action
Body of Log in JSON
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"id": "integer (int64)",
"time": "string (date-time)",
"user": "string",
"path": "string",
"action": "string",
"resourceType": "string",
"resourceUuid": "string",
"remoteAddress": "string",
"remoteHost": "string"
}
200 OK
successful operation
404 Not Found
User session not found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "integer (int64)",
"time": "string (date-time)",
"user": "string",
"path": "string",
"action": "string",
"resourceType": "string",
"resourceUuid": "string",
"remoteAddress": "string",
"remoteHost": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Log an error in the frontend
Body of Error in JSON
SESSION_KEY
User's session authentication key
type
string
in
header
Request Example
{
"user": "string",
"path": "string",
"message": "string"
}
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "integer (int64)",
"time": "string (date-time)",
"user": "string",
"path": "string",
"action": "string",
"resourceType": "string",
"resourceUuid": "string",
"remoteAddress": "string",
"remoteHost": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
Log an action
Body of Log in JSON
Request Example
{
"id": "integer (int64)",
"time": "string (date-time)",
"user": "string",
"path": "string",
"action": "string",
"resourceType": "string",
"resourceUuid": "string",
"remoteAddress": "string",
"remoteHost": "string"
}
200 OK
successful operation
404 Not Found
User not found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "integer (int64)",
"time": "string (date-time)",
"user": "string",
"path": "string",
"action": "string",
"resourceType": "string",
"resourceUuid": "string",
"remoteAddress": "string",
"remoteHost": "string"
}
Response Example (404 Not Found)
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
OPTIONS /{path}
path
(no description)
type
string
in
path
200 OK
successful operation
Response Example (200 OK)
"object"
Schema Definitions
CustomFieldValue: object
Model reprensenting Custom field value
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- customFieldValueId: integer (int64)
- uuid: string (uuid)
- entityTargetType: string
- entityTargetUuid: string (uuid)
- value: string
- customFieldDefinition: CustomFieldDefinition
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
SecurityRole: object
Roles assigned to Users
- roleId: integer (int64)
- name: string
Example
{
"roleId": "integer (int64)",
"name": "string"
}
BallotTransfer: object
- id: integer (int64)
- uuid: string (uuid)
- password: string
- instructions: string
- notes: string
- votingSystemType: string RANGE, RANKED, DISTRIBUTED, PLURALITY, CONSENSUS
- status: string ACTIVE, ARCHIVED, DRAFT
- requireRegistration: boolean
- userUuidAsSignature: boolean
- decisionType: string
- entityType: string
- component: Component
- startsAt: string (date-time)
- endsAt: string (date-time)
- ballotCandidates: BallotCandidate
- candidateType: string EXTERNAL, ASSEMBLY, CONTRIBUTION, CAMPAIGN, USER, GROUP
- ballotConfigs: BallotConfiguration
Example
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"component": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
]
}
}
}
]
}
}
PasswordForgotChange: object
- password: string
- repeatPassword: string
- token: string
Example
{
"password": "string",
"repeatPassword": "string",
"token": "string"
}
UpdateTransfer: object
- type: string UPCOMING_MILESTONE, ASSEMBLY_UPDATE, CAMPAIGN_UPDATE, WORKING_GROUP_UPDATE, CONTRIBUTION_UPDATE, PRIVATE_MESSAGE, FOLLOWED_ASSEMBLY_UPDATE, FOLLOWED_CAMPAIGN_UPDATE
- resourceType: string CONTRIBUTION_IDEA, CONTRIBUTION_QUESTION, CONTRIBUTION_COMMENT, CONTRIBUTION_ISSUE, CONTRIBUTION_FORUM_POST, CONTRIBUTION_ACTION_ITEM, CONTRIBUTION_BRAINSTORMING, CONTRIBUTION_PROPOSAL, CONTRIBUTION_DISCUSSION, ELECTION, BALLOT, VOTE, PROPOSAL_TEMPLATE, EXTERNAL, ASSEMBLY, CAMPAIGN, CAMPAIGN_COMPONENT, WORKING_GROUP, PICTURE, VIDEO, PAD, TEXT, WEBPAGE, FILE
- containerType: string CONTRIBUTION_IDEA, CONTRIBUTION_QUESTION, CONTRIBUTION_COMMENT, CONTRIBUTION_ISSUE, CONTRIBUTION_FORUM_POST, CONTRIBUTION_ACTION_ITEM, CONTRIBUTION_BRAINSTORMING, CONTRIBUTION_PROPOSAL, CONTRIBUTION_DISCUSSION, ELECTION, BALLOT, VOTE, PROPOSAL_TEMPLATE, EXTERNAL, ASSEMBLY, CAMPAIGN, CAMPAIGN_COMPONENT, WORKING_GROUP, PICTURE, VIDEO, PAD, TEXT, WEBPAGE, FILE
- title: string
- text: string
- resourceSummary: string
- resourceId: integer (int64)
- resourceUUID: string (uuid)
- containerId: integer (int64)
- containerUUID: string (uuid)
- date: string (date-time)
- lang: string
- relativeUrl: string
- resource: object
- container: object
Example
{
"type": "string",
"resourceType": "string",
"containerType": "string",
"title": "string",
"text": "string",
"resourceSummary": "string",
"resourceId": "integer (int64)",
"resourceUUID": "string (uuid)",
"containerId": "integer (int64)",
"containerUUID": "string (uuid)",
"date": "string (date-time)",
"lang": "string",
"relativeUrl": "string",
"resource": "object",
"container": "object"
}
ContributionTemplate: object
Template for a contribution
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- id: integer (int64)
- uuid: string (uuid)
- uuidAsString: string
- templateSections: ContributionTemplateSection
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"templateSections": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"title": "string",
"description": "string",
"length": "integer (int32)",
"position": "integer (int32)"
}
]
}
MembershipInvitation: object
Invitation to become a member of a Working Group or an Assembly
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- id: integer (int64)
- email: string
- userId: integer (int64)
- status: string ACCEPTED, REQUESTED, INVITED, FOLLOWING, REJECTED
- token: TokenAction
- targetId: integer (int64)
- targetType: string ASSEMBLY, GROUP
- roles: SecurityRole
- targetAssembly: Assembly
- targetGroup: WorkingGroup
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"email": "string",
"userId": "integer (int64)",
"status": "string",
"token": {
"id": "integer (int64)",
"token": "string",
"targetUser": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)"
}
}
}
}
}
}
}
}
}
LinkedAccount: object
Connected accounts to users (e.g., google, facebok, etc.)
- accountId: integer (int64)
- user: User
- providerUserId: string
- providerKey: string
Example
{
"accountId": "integer (int64)",
"user": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
}
}
}
}
}
}
}
}
ContributionTemplateSectionTransfer: object
- id: integer (int64)
- uuid: string (uuid)
- title: string
- description: string
- length: integer (int32)
- position: integer (int32)
Example
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"length": "integer (int32)",
"position": "integer (int32)"
}
ComponentRequiredConfiguration: object
A configuration required by the definition of component for a campaign
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- componentRequiredConfigurationId: integer (int64)
- componentDef: ComponentDefinition
- configDef: ConfigDefinition
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)"
}
}
]
}
}
]
}
}
]
}
}
]
}
}
CampaignBriefTransfer: object
- brief: string
- campaignUuid: string (uuid)
Example
{
"brief": "string",
"campaignUuid": "string (uuid)"
}
WorkingGroupProfile: object
Profile of Working Groups
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- workingGroupProfileId: integer (int64)
- workingGroup: WorkingGroup
- supportedMembership: string OPEN, INVITATION, REQUEST, INVITATION_AND_REQUEST
- managementType: string OPEN, COORDINATED, MODERATED, COORDINATED_AND_MODERATED, DEMOCRATIC
- icon: string
- cover: string
- color: string
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"workingGroupProfileId": "integer (int64)",
"workingGroup": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)"
}
}
}
}
}
}
}
}
AssemblyProfile: object
The profile of an Assembly
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- assemblyProfileId: integer (int64)
- assembly: Assembly
- targetAudience: string
- supportedMembership: string OPEN, INVITATION, REQUEST, INVITATION_AND_REQUEST
- managementType: string OPEN, COORDINATED, MODERATED, COORDINATED_AND_MODERATED, DEMOCRATIC
- icon: string
- cover: string
- primaryContactName: string
- primaryContactPhone: string
- primaryContactEmail: string
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean"
}
}
}
}
}
}
}
}
BallotCandidate: object
The pointer to a candidate in a a ballot paper. Represents a resource in AppCivist through its UUID
- id: integer (int64)
- ballotId: integer (int64)
- uuid: string (uuid)
- candidateType: string EXTERNAL, ASSEMBLY, CONTRIBUTION, CAMPAIGN, USER, GROUP
- candidateUuid: string (uuid)
- candidateUuidAsString: string
- createdAt: string (date-time)
- updatedAt: string (date-time)
- removed: boolean
- removedAt: string (date-time)
- contributionSummary: object
Example
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
Membership: object
A Membership connects a user to an Assembly or a Working Group, assigning a role that is used for authorization purposes. Only Coordinators have the power to create and update memberships. Members can delete their own memberships.
- userId: integer (int64)
- groupId: integer (int64)
- assemblyId: integer (int64)
- email: string
-
Email of the person for whom a membership will be created
- type: string ASSEMBLY, GROUP
-
Type identifies what type of membership depending on the target
- targetCollection: string
-
targetCollection is the the ID of the Assembly or Working Group to which we are associating the user
- defaultRoleId: integer (int64)
- defaultRoleName: string
- status: string REQUESTED, INVITED, ACCEPTED or REJECTED
-
status
Example
{
"userId": "integer (int64)",
"groupId": "integer (int64)",
"assemblyId": "integer (int64)",
"email": "string",
"type": "string",
"targetCollection": "string",
"defaultRoleId": "integer (int64)",
"defaultRoleName": "string",
"status": "string"
}
ApiResponseTransfer: object
- pageSize: integer (int32)
- totalCount: integer (int32)
- results: number[]
Example
{
"pageSize": "integer (int32)",
"totalCount": "integer (int32)",
"results": [
"number"
]
}
Subscription: object
Subsription for Notifications Support
- userId: string
- spaceId: string
- spaceType: string CAMPAIGN, CONTRIBUTION, ASSEMBLY, WORKING_GROUP, IDEA
- subscriptionType: string REGULAR, NEWSLETTER
- newsletterFrecuency: integer (int32)
- ignoredEvents: object
- disabledServices: object
- defaultService: integer (int32)
- defaultIdentity: integer (int32)
Example
{
"userId": "string",
"spaceId": "string",
"spaceType": "string",
"subscriptionType": "string",
"newsletterFrecuency": "integer (int32)",
"ignoredEvents": "object",
"disabledServices": "object",
"defaultService": "integer (int32)",
"defaultIdentity": "integer (int32)"
}
Assembly: object
An Assembly is an a space owned by a group of people to organize democratic actions
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- assemblyId: integer (int64)
- uuid: string (uuid)
- uuidAsString: string
- name: string
- shortname: string
- description: string
- url: string
- listed: boolean
- invitationEmail: string
- principalAssembly: boolean
- profile: AssemblyProfile
- location: Location
- creator: User
- components: Component
- configs: Config
- themes: Theme
- organizations: Organization
- workingGroups: WorkingGroup
- campaigns: Campaign
- forumPosts: Contribution
- forumResourceSpaceId: integer (int64)
- resourcesResourceSpaceId: integer (int64)
- forumResourceSpaceUUID: string (uuid)
- resourcesResourceSpaceUUID: string (uuid)
- followedAssemblies: Assembly
- followingAssemblies: Assembly
- existingComponents: Component
- existingConfigs: Config
- existingThemes: Theme
- existingWorkingGroups: WorkingGroup
- existingCampaigns: Campaign
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)",
"assembly": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"name": "string",
"shortname": "string",
"description": "string",
"url": "string",
"listed": "boolean",
"invitationEmail": "string",
"principalAssembly": "boolean",
"profile": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"assemblyProfileId": "integer (int64)"
}
}
}
}
}
}
}
}
ThemeListTransfer: object
- themes: Theme
Example
{
"themes": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
]
}
MySignup: object
- email: string
- password: string
- repeatPassword: string
- name: string
- lang: string
- newAssembly: AssemblyTransfer
- existingAssembly: AssemblyTransfer
- invitationToken: string (uuid)
Example
{
"email": "string",
"password": "string",
"repeatPassword": "string",
"name": "string",
"lang": "string",
"newAssembly": {
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"shortname": "string",
"description": "string",
"listed": "boolean",
"invitationEmail": "string",
"profile": {
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
},
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"organizations": [
{
"organizationId": "integer (int64)",
"title": "string",
"description": "string",
"logo": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
}
],
"themes": [
{
"title": "string",
"description": "string"
}
],
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"configs": [
{
"configId": "integer (int64)",
"key": "string",
"value": "string"
}
],
"invitations": [
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
],
"linkedAssemblies": [
null
]
}
}
ContributionHistoryItem: object
- internalChanges: string[]
- externalChanges: ContributionHistoryExternalChange
- associationChanges: ContributionHistoryAssociationChange
Example
{
"internalChanges": [
"string"
],
"externalChanges": [
{
"externalRef": "string",
"externalRefId": "integer (int64)",
"changeType": "string"
}
],
"associationChanges": [
{
"resourceSpaceId": "integer (int64)",
"type": "string",
"changeType": "string"
}
]
}
ComponentTransfer: object
- componentId: integer (int64)
- title: string
- description: string
- key: string
- startDate: string (date-time)
- endDate: string (date-time)
- uuid: string (uuid)
- position: integer (int32)
- timeline: integer (int32)
- linked: boolean
- milestones: ComponentMilestoneTransfer
- deletedMilestones: ComponentMilestoneTransfer
- contributions: ContributionTransfer
- ballots: VotingBallotTransfer
- templates: ContributionTemplateTransfer
- configs: ConfigsTransfer
- type: string IDEAS, PROPOSALS, DELIBERATION, VOTING, IMPLEMENTATION
Example
{
"componentId": "integer (int64)",
"title": "string",
"description": "string",
"key": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"milestones": [
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
],
"deletedMilestones": [
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
],
"contributions": [
{
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"budget": "string",
"authors": [
"object"
],
"workingGroupAuthors": [
"object"
],
"stats": "object",
"themes": [
{
"title": "string",
"description": "string"
}
],
"attachments": [
{
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
],
"comments": [
null
]
}
]
}
Log: object
Log record for registering events in the system
- id: integer (int64)
- time: string (date-time)
- user: string
- path: string
- action: string
- resourceType: string
- resourceUuid: string
- remoteAddress: string
- remoteHost: string
Example
{
"id": "integer (int64)",
"time": "string (date-time)",
"user": "string",
"path": "string",
"action": "string",
"resourceType": "string",
"resourceUuid": "string",
"remoteAddress": "string",
"remoteHost": "string"
}
Resource: object
Resource represents external resources, accessible through an URL
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- resourceId: integer (int64)
- uuid: string (uuid)
- url: string (url)
- urlAsString: string
- creator: User
- location: Location
- resourceType: string PROPOSAL, PICTURE, VIDEO, PAD, TEXT, WEBPAGE, FILE, AUDIO, CONTRIBUTION_TEMPLATE, GDOC
- name: string
- title: string
- description: string
- readOnlyPadId: string
- resourceSpaceWithServerConfigs: string (uuid)
- confirmed: boolean
- urlLargeString: string
- urlMediumString: string
- urlThumbnailString: string
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string"
}
}
}
}
}
}
}
}
CustomFieldDefinition: object
Model reprensenting Custom field definition
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- customFieldDefinitionId: integer (int64)
- uuid: string (uuid)
- name: string
- description: string
- entityType: string ASSEMBLY, CAMPAIGN, WORKING_GROUP, COMPONENT, MILESTONE, CONTRIBUTION, CONTRIBUTION_FEEDBACK, BALLOT, NON_MEMBER_AUTHOR
- entityFilterAttributeName: string
- entityFilter: string
- fieldType: string
- position: integer (int32)
- limit: string
- limitType: string CHARS, WORDS, FILE_SIZE, CHOICE
- customFieldValueOptions: CustomFieldValueOption
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
ContributionTemplateTransfer: object
- id: integer (int64)
- uuid: string (uuid)
- templateSections: ContributionTemplateSectionTransfer
Example
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"templateSections": [
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"length": "integer (int32)",
"position": "integer (int32)"
}
]
}
ResourceSpace: object
A Resource Space connects entities in the model to other entities
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- resourceSpaceId: integer (int64)
- uuid: string (uuid)
- uuidAsString: string
- type: string ASSEMBLY, CAMPAIGN, WORKING_GROUP, COMPONENT, CONTRIBUTION, VOTING_BALLOT
- parent: string (uuid)
- name: string
- configs: Config
- organizations: Organization
- customFieldDefinitions: CustomFieldDefinition
- customFieldValues: CustomFieldValue
- themes: Theme
- campaigns: Campaign
- components: Component
- milestones: ComponentMilestone
- workingGroups: WorkingGroup
- contributions: Contribution
- contributionHistories: ContributionHistory
- assemblies: Assembly
- resources: Resource
- hashtags: Hashtag
- ballots: Ballot
- templates: ContributionTemplate
- consensusBallot: string (uuid)
- consensusBallotAsString: string
- resourceSpaceUuid: string (uuid)
- groupsFilteredByTopic: WorkingGroup
- campaignCountByStatus: object
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string"
}
}
}
}
}
]
}
Campaign: object
Campaigns are actions or processes organized by an Assembly
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- campaignId: integer (int64)
- title: string
- shortname: string
- goal: string
- url: string
- uuid: string (uuid)
- uuidAsString: string
- listed: boolean
- currentBallot: string (uuid)
- forum: ResourceSpace
- resourceSpaceId: integer (int64)
- resourceSpaceUUID: string
- forumResourceSpaceId: integer (int64)
- forumResourceSpaceUUID: string
- components: Component
- transientComponents: Component
- configs: Config
- resourceList: Resource
- assemblies: integer[]
- existingComponents: Component
- existingConfigs: Config
- existingThemes: Theme
- existingWorkingGroups: WorkingGroup
- template: CampaignTemplate
- cover: Resource
- logo: Resource
- externalBallot: string
- creator: User
- startDate: string (date-time)
- endDate: string (date-time)
- active: boolean
- past: boolean
- upcoming: boolean
- componentsByTimeline: Component
- ballotIndex: object
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean"
}
}
}
}
]
}
}
CampaignSummaryTransfer: object
- title: string
- shortname: string
- goal: string
- configs: ConfigTransfer
- themes: ThemeTransfer
- workingGroups: WorkingGroupSummaryTransfer
- timelineEdges: CampaignTimelineEdgeTransfer
Example
{
"title": "string",
"shortname": "string",
"goal": "string",
"configs": [
{
"configId": "integer (int64)",
"key": "string",
"value": "string"
}
],
"themes": [
{
"title": "string",
"description": "string"
}
],
"workingGroups": [
{
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"profile": {
"workingGroupProfileId": "integer (int64)",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string"
},
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"resourcesResourceSpaceId": "integer (int64)",
"forumResourceSpaceId": "integer (int64)",
"resourcesResourceSpaceUUID": "string",
"forumResourceSpaceUUID": "string",
"topic": "boolean"
}
],
"timelineEdges": {
"edgeId": "integer (int64)",
"fromComponent": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)"
}
}
}
]
}
}
}
AssemblyTransfer: object
- assemblyId: integer (int64)
- uuid: string (uuid)
- name: string
- shortname: string
- description: string
- listed: boolean
- invitationEmail: string
- profile: AssemblyProfileTransfer
- location: LocationTransfer
- organizations: OrganizationTransfer
- themes: ThemeTransfer
- existingThemes: ThemeTransfer
- configs: ConfigTransfer
- invitations: InvitationTransfer
- linkedAssemblies: LinkedAssemblyTransfer
- linkedAssembliesIds: integer[]
Example
{
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"shortname": "string",
"description": "string",
"listed": "boolean",
"invitationEmail": "string",
"profile": {
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
},
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"organizations": [
{
"organizationId": "integer (int64)",
"title": "string",
"description": "string",
"logo": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
}
],
"themes": [
{
"title": "string",
"description": "string"
}
],
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"configs": [
{
"configId": "integer (int64)",
"key": "string",
"value": "string"
}
],
"invitations": [
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
],
"linkedAssemblies": [
{
"assemblyId": "integer (int64)"
}
],
"linkedAssembliesIds": [
"integer (int64)"
]
}
CampaignRequiredConfiguration: object
Required configuration value for a particular campaign
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- campaignRequiredConfigurationId: integer (int64)
- uuid: string (uuid)
- campaignTemplate: CampaignTemplate
- configDefinition: ConfigDefinition
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignRequiredConfigurationId": "integer (int64)",
"uuid": "string (uuid)",
"campaignTemplate": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignTemplateId": "integer (int64)",
"nameKey": "string",
"name": "string",
"defComponents": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string"
}
]
}
}
]
}
}
]
}
}
]
}
]
}
}
ContributionTemplateSection: object
Section of the template for a contribution
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- id: integer (int64)
- uuid: string (uuid)
- uuidAsString: string
- title: string
- description: string
- length: integer (int32)
- position: integer (int32)
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"title": "string",
"description": "string",
"length": "integer (int32)",
"position": "integer (int32)"
}
CampaignTimelineEdge: object
Edge in the graph that represents the workflow of components associated to a campaign with a process
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- edgeId: integer (int64)
- campaign: Campaign
- start: boolean
- fromComponent: Component
- fromComponentId: integer (int64)
- toComponent: Component
- toComponentId: integer (int64)
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string"
}
}
}
]
}
}
}
TokenAction: object
Generated tokens for verificatoin and other security actions
- id: integer (int64)
- token: string
- targetUser: User
- targetInvitation: MembershipInvitation
- type: string EMAIL_VERIFICATION, PASSWORD_RESET, MEMBERSHIP_INVITATION, MEMBERSHIP_REQUEST, FACEBOOK_TOKEN
- created: string (date-time)
- expires: string (date-time)
- valid: boolean
Example
{
"id": "integer (int64)",
"token": "string",
"targetUser": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
}
}
}
}
}
}
}
}
File: object
Example
{
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
NotificationSubscriptionTransfer: object
Basic Notification Subscription
- eventId: string
- alertEndpoint: string
- endpointType: string
- origin: string (uuid)
- eventName: string NEW_CAMPAIGN, NEW_WORKING_GROUP, NEW_VOTING_BALLOT, NEW_MILESTONE, NEW_CONTRIBUTION_IDEA, NEW_CONTRIBUTION_PROPOSAL, NEW_CONTRIBUTION_DISCUSSION, NEW_CONTRIBUTION_COMMENT, NEW_CONTRIBUTION_NOTE, NEW_CONTRIBUTION_FORUM_POST, NEW_CONTRIBUTION_FEEDBACK, NEW_CONTRIBUTION_ISSUE, UPDATED_ASSEMBLY, UPDATED_CAMPAIGN, UPDATED_WORKING_GROUP, UPDATED_VOTING_BALLOT, UPDATED_MILESTONE, UPDATED_CONTRIBUTION_IDEA, UPDATED_CONTRIBUTION_PROPOSAL, UPDATED_CONTRIBUTION_DISCUSSION, UPDATED_CONTRIBUTION_COMMENT, UPDATED_CONTRIBUTION_NOTE, UPDATED_CONTRIBUTION_FORUM_POST, UPDATED_CONTRIBUTION_FEEDBACK, UPDATED_CONTRIBUTION_HISTORY, MILESTONE_PASSED, MILESTONE_UPCOMING, MILESTONE_UPCOMING_IN_A_WEEK, MILESTONE_UPCOMING_IN_A_DAY, BALLOT_UPCOMING_IN_A_DAY, BALLOT_UPCOMING_IN_A_WEEK, BALLOT_UPCOMING_IN_A_MONTH, BALLOT_ENDING_IN_A_DAY, BALLOT_ENDING_IN_A_WEEK, BALLOT_ENDING_IN_A_MONTH, UPDATED_ASSEMBLY_CONFIGS, UPDATED_CAMPAIGN_CONFIGS, UPDATED_WORKING_GROUP_CONFIGS, MEMBER_JOINED, DELETED_CONTRIBUTION, MODERATED_CONTRIBUTION, NEW_CONTRIBUTION_FEEDBACK_FLAG, NEWSLETTER
Example
{
"eventId": "string",
"alertEndpoint": "string",
"endpointType": "string",
"origin": "string (uuid)",
"eventName": "string"
}
ComponentRequiredMilestone: object
A milestone required in the definition of component for a campaign
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- componentRequiredMilestoneId: integer (int64)
- title: string
- description: string
- key: string
- position: integer (int32)
- noDuration: boolean
- type: string START, END, REMINDER
- targetComponentUuidAsString: string
- campaignTemplate: CampaignTemplate
- componentDefinition: ComponentDefinition
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredMilestoneId": "integer (int64)",
"title": "string",
"description": "string",
"key": "string",
"position": "integer (int32)",
"noDuration": "boolean",
"type": "string",
"targetComponentUuidAsString": "string",
"campaignTemplate": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignTemplateId": "integer (int64)",
"nameKey": "string",
"name": "string",
"defComponents": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string"
}
}
]
}
}
]
}
}
]
}
]
}
}
User: object
Model representing each user in AppCivist
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- userId: integer (int64)
- uuid: string (uuid)
- uuidAsString: string
- email: string
- name: string
- username: string
- language: string
- emailVerified: boolean
- profilePic: Resource
- active: boolean
- sessionKey: string
- roles: SecurityRole
- permissions: Permission
- providers: string[]
- identifier: string
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)"
}
}
}
}
}
}
}
}
Organization: object
Model reprensenting Organizations within an Assembly
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- organizationId: integer (int64)
- uuid: string (uuid)
- title: string
- description: string
- logo: Resource
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string"
}
}
}
}
}
}
}
}
UserProfile: object
Profile of Users
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- profileId: integer (int64)
- uuidAsString: string
- name: string
- middleName: string
- lastName: string
- birthdate: string (date-time)
- address: string
- note: string
- phone: string
- gender: string
- configs: Config
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"profileId": "integer (int64)",
"uuidAsString": "string",
"name": "string",
"middleName": "string",
"lastName": "string",
"birthdate": "string (date-time)",
"address": "string",
"note": "string",
"phone": "string",
"gender": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
]
}
AssemblySummaryTransfer: object
- assemblyId: integer (int64)
- uuid: string (uuid)
- shortname: string
- name: string
- profile: AssemblyProfileTransfer
- themes: ThemeTransfer
Example
{
"assemblyId": "integer (int64)",
"uuid": "string (uuid)",
"shortname": "string",
"name": "string",
"profile": {
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
},
"themes": [
{
"title": "string",
"description": "string"
}
]
}
Config: object
Generic model to store a configuration value
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- uuid: string (uuid)
- key: string
- value: string
- configTarget: string ASSEMBLY, CAMPAIGN, COMPONENT, WORKING_GROUP, MODULE, PROPOSAL, CONTRIBUTION, USER
- targetUuid: string (uuid)
- targetUuidAsString: string
- definition: ConfigDefinition
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
ConfigTransfer: object
- configId: integer (int64)
- key: string
- value: string
Example
{
"configId": "integer (int64)",
"key": "string",
"value": "string"
}
ContributionFeedback: object
Feedback associated to a contribution
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- id: integer (int64)
- up: boolean
- down: boolean
- fav: boolean
- flag: boolean
- userId: integer (int64)
- benefit: integer (int32)
- need: integer (int32)
- feasibility: integer (int32)
- elegibility: boolean
- textualFeedback: string
- type: string MEMBER, WORKING_GROUP, TECHNICAL_ASSESSMENT
- status: string PUBLIC, PRIVATE
- workingGroupId: integer (int64)
- officialGroupFeedback: boolean
- archived: boolean
- nonMemberAuthor: NonMemberAuthor
- password: string
- workingGroupUuid: string (uuid)
- parentType: string ISSUE, QUESTION, IDEA, COMMENT, PROPOSAL, ASSESSMENT, FORUM_POST, ACTION_ITEM, DISCUSSION, BRAINSTORMING, DELIBERATIVE_DISCUSSION, NOTE
- contributionId: integer (int64)
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"up": "boolean",
"down": "boolean",
"fav": "boolean",
"flag": "boolean",
"userId": "integer (int64)",
"benefit": "integer (int32)",
"need": "integer (int32)",
"feasibility": "integer (int32)",
"elegibility": "boolean",
"textualFeedback": "string",
"type": "string",
"status": "string",
"workingGroupId": "integer (int64)",
"officialGroupFeedback": "boolean",
"archived": "boolean",
"nonMemberAuthor": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
},
"password": "string",
"workingGroupUuid": "string (uuid)",
"parentType": "string",
"contributionId": "integer (int64)"
}
S3File: object
- id: string (uuid)
- name: string
- file: File
- url: string (url)
Example
{
"id": "string (uuid)",
"name": "string",
"file": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean",
"canonicalPath": "string",
"parentFile": {
"path": "string",
"name": "string",
"parent": "string",
"absolute": "boolean"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
BallotConfiguration: object
key,value configurations for a voting ballot
- id: integer (int64)
- ballotId: integer (int64)
- key: string
- value: string
- position: integer (int32)
- createdAt: string (date-time)
- updatedAt: string (date-time)
- removed: boolean
- removedAt: string (date-time)
Example
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"key": "string",
"value": "string",
"position": "integer (int32)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)"
}
WorkingGroupProfileTransfer: object
- workingGroupProfileId: integer (int64)
- supportedMembership: string OPEN, INVITATION, REQUEST, INVITATION_AND_REQUEST
- managementType: string OPEN, COORDINATED, MODERATED, COORDINATED_AND_MODERATED, DEMOCRATIC
- icon: string
- cover: string
Example
{
"workingGroupProfileId": "integer (int64)",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string"
}
ComponentMilestoneTransfer: object
- componentMilestoneId: integer (int64)
- title: string
- position: integer (int32)
- description: string
- key: string
- type: string START, END, REMINDER
- start: string (date-time)
- date: string (date-time)
- days: integer (int32)
- uuid: string (uuid)
- uuidAsString: string
- mainContributionType: string ISSUE, QUESTION, IDEA, COMMENT, PROPOSAL, ASSESSMENT, FORUM_POST, ACTION_ITEM, DISCUSSION, BRAINSTORMING, DELIBERATIVE_DISCUSSION, NOTE
Example
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
CampaignTimelineEdgeTransfer: object
Example
{
"edgeId": "integer (int64)",
"fromComponent": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)"
}
}
]
}
}
}
]
}
}
ConfigDefinition: object
Definition of a configuration value
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- uuid: string (uuid)
- key: string
- valueType: string
- description: string
- defaultValue: string
- configTarget: string ASSEMBLY, CAMPAIGN, COMPONENT, WORKING_GROUP, MODULE, PROPOSAL, CONTRIBUTION, USER
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
Component: object
A component represents a space of action within a campaign. It can be the stage in a process or the space of deliberation when a campaign des not have a process
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- componentId: integer (int64)
- title: string
- type: string IDEAS, PROPOSALS, DELIBERATION, VOTING, IMPLEMENTATION
- key: string
- description: string
- startDate: string (date-time)
- endDate: string (date-time)
- uuid: string (uuid)
- position: integer (int32)
- timeline: integer (int32)
- linked: boolean
- fromEdges: CampaignTimelineEdge
- toEdges: CampaignTimelineEdge
- definition: ComponentDefinition
- resourceSpaceId: integer (int64)
- resourceSpaceUUID: string
- configs: Config
- milestones: ComponentMilestone
- contributions: Contribution
- templates: ContributionTemplate
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentId": "integer (int64)",
"title": "string",
"type": "string",
"key": "string",
"description": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"fromEdges": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"edgeId": "integer (int64)",
"campaign": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"uuidAsString": "string",
"listed": "boolean",
"currentBallot": "string (uuid)",
"forum": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceSpaceId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"parent": "string (uuid)",
"name": "string",
"configs": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"value": "string",
"configTarget": "string",
"targetUuid": "string (uuid)",
"targetUuidAsString": "string",
"definition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"uuid": "string (uuid)",
"key": "string",
"valueType": "string",
"description": "string",
"defaultValue": "string",
"configTarget": "string"
}
}
],
"organizations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"organizationId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"description": "string",
"logo": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
]
}
}
}
]
}
ContributionHistory: object
History of changes and events related to a contribution
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- contributionHistoryId: integer (int64)
- contributionId: integer (int64)
- uuid: string (uuid)
- title: string
- text: string
- type: string ISSUE, QUESTION, IDEA, COMMENT, PROPOSAL, ASSESSMENT, FORUM_POST, ACTION_ITEM, DISCUSSION, BRAINSTORMING, DELIBERATIVE_DISCUSSION, NOTE
- textIndex: string
- moderationComment: string
- budget: string
- actionDueDate: string (date-time)
- actionDone: boolean
- action: string
- assessmentSummary: string
- authors: User
- changes: ContributionHistoryItem
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionHistoryId": "integer (int64)",
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"moderationComment": "string",
"budget": "string",
"actionDueDate": "string (date-time)",
"actionDone": "boolean",
"action": "string",
"assessmentSummary": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {}
}
}
}
}
}
}
]
}
ContributionHistoryExternalChange: object
- externalRef: string
- externalRefId: integer (int64)
- changeType: string ADDED, DELETED, MODIFIED
Example
{
"externalRef": "string",
"externalRefId": "integer (int64)",
"changeType": "string"
}
Hashtag: object
Hashtags represents keywords associated to resources in the system
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- hashtagId: integer (int64)
- hashtag: string
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"hashtagId": "integer (int64)",
"hashtag": "string"
}
ResourceTransfer: object
- resourceId: integer (int64)
- uuid: string (uuid)
- url: string (url)
- creator: UserTransfer
- location: LocationTransfer
- resourceType: string PROPOSAL, PICTURE, VIDEO, PAD, TEXT, WEBPAGE, FILE, AUDIO, CONTRIBUTION_TEMPLATE, GDOC
- name: string
- padId: string
- readOnlyPadId: string
- resourceSpaceWithServerConfigs: string (uuid)
- urlLarge: string (url)
- urlMedium: string (url)
- urlThumbnail: string (url)
Example
{
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
ObjectNode: object
- nodeType: string ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING
- float: boolean
- valueNode: boolean
- binary: boolean
- containerNode: boolean
- missingNode: boolean
- object: boolean
- pojo: boolean
- number: boolean
- integralNumber: boolean
- floatingPointNumber: boolean
- short: boolean
- int: boolean
- long: boolean
- double: boolean
- bigDecimal: boolean
- bigInteger: boolean
- textual: boolean
- boolean: boolean
- array: boolean
- null: boolean
Example
{
"nodeType": "string",
"float": "boolean",
"valueNode": "boolean",
"binary": "boolean",
"containerNode": "boolean",
"missingNode": "boolean",
"object": "boolean",
"pojo": "boolean",
"number": "boolean",
"integralNumber": "boolean",
"floatingPointNumber": "boolean",
"short": "boolean",
"int": "boolean",
"long": "boolean",
"double": "boolean",
"bigDecimal": "boolean",
"bigInteger": "boolean",
"textual": "boolean",
"boolean": "boolean",
"array": "boolean",
"null": "boolean"
}
ContributionTransfer: object
- contributionId: integer (int64)
- uuid: string (uuid)
- uuidAsString: string
- title: string
- text: string
- type: string ISSUE, QUESTION, IDEA, COMMENT, PROPOSAL, ASSESSMENT, FORUM_POST, ACTION_ITEM, DISCUSSION, BRAINSTORMING, DELIBERATIVE_DISCUSSION, NOTE
- textIndex: string
- location: LocationTransfer
- budget: string
- authors: UserTransfer
- workingGroupAuthors: WorkingGroupTransfer
- stats: ContributionStatisticsTransfer
- themes: ThemeTransfer
- attachments: ResourceTransfer
- comments: ContributionTransfer
- associatedMilestones: ComponentMilestoneTransfer
- inspirations: ContributionTransfer
- actionDueDate: string (date-time)
- actionDone: boolean
- action: string
- assessmentSummary: string
- extendedTextPad: ResourceTransfer
- assessments: ContributionTransfer
- existingResponsibleWorkingGroups: WorkingGroupTransfer
- existingContributions: ContributionTransfer
Example
{
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"budget": "string",
"authors": [
"object"
],
"workingGroupAuthors": [
"object"
],
"stats": "object",
"themes": [
{
"title": "string",
"description": "string"
}
],
"attachments": [
{
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
],
"comments": [
{
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"budget": "string",
"authors": [
"object"
],
"workingGroupAuthors": [
"object"
],
"stats": "object",
"themes": [
{
"title": "string",
"description": "string"
}
],
"attachments": [
{
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)"
}
}
]
}
]
}
AssemblyProfileTransfer: object
- targetAudience: string
- supportedMembership: string OPEN, INVITATION, REQUEST, INVITATION_AND_REQUEST
- managementType: string OPEN, COORDINATED, MODERATED, COORDINATED_AND_MODERATED, DEMOCRATIC
- icon: string
- cover: string
- primaryContactName: string
- primaryContactPhone: string
- primaryContactEmail: string
- location: LocationTransfer
Example
{
"targetAudience": "string",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string",
"primaryContactName": "string",
"primaryContactPhone": "string",
"primaryContactEmail": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
}
ComponentMilestone: object
Milestone associated to a component. It represents a deadline within that component
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- componentMilestoneId: integer (int64)
- title: string
- key: string
- position: integer (int32)
- description: string
- date: string (date-time)
- days: integer (int32)
- uuid: string (uuid)
- uuidAsString: string
- type: string START, END, REMINDER
- mainContributionType: string ISSUE, QUESTION, IDEA, COMMENT, PROPOSAL, ASSESSMENT, FORUM_POST, ACTION_ITEM, DISCUSSION, BRAINSTORMING, DELIBERATIVE_DISCUSSION, NOTE
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentMilestoneId": "integer (int64)",
"title": "string",
"key": "string",
"position": "integer (int32)",
"description": "string",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"type": "string",
"mainContributionType": "string"
}
Ballot: object
Represents a ballot used for voting on AppCivist Core resources (contributions, users, working groups, themes, etc.)
- id: integer (int64)
- uuid: string (uuid)
- password: string
- instructions: string
- notes: string
- votingSystemType: string RANGE, RANKED, DISTRIBUTED, PLURALITY, CONSENSUS
- status: string ACTIVE, ARCHIVED, DRAFT
- requireRegistration: boolean
- userUuidAsSignature: boolean
- decisionType: string
- entityType: string
- startsAt: string (date-time)
- endsAt: string (date-time)
- createdAt: string (date-time)
- updatedAt: string (date-time)
- removed: boolean
- removedAt: string (date-time)
- votesLimit: string
-
The limit on the votes a voter can give on this ballot
- votesLimitMeaning: string SELECTIONS, TOKENS, RANGE
-
Meaning of the limit on the votes
- ballotCandidates: BallotCandidate
- componentId: integer (int64)
- ballotCandidatesIndex: object
- candidatesNumber: integer (int32)
Example
{
"id": "integer (int64)",
"uuid": "string (uuid)",
"password": "string",
"instructions": "string",
"notes": "string",
"votingSystemType": "string",
"status": "string",
"requireRegistration": "boolean",
"userUuidAsSignature": "boolean",
"decisionType": "string",
"entityType": "string",
"startsAt": "string (date-time)",
"endsAt": "string (date-time)",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"votesLimit": "string",
"votesLimitMeaning": "string",
"ballotCandidates": [
{
"id": "integer (int64)",
"ballotId": "integer (int64)",
"uuid": "string (uuid)",
"candidateType": "string",
"candidateUuid": "string (uuid)",
"candidateUuidAsString": "string",
"createdAt": "string (date-time)",
"updatedAt": "string (date-time)",
"removed": "boolean",
"removedAt": "string (date-time)",
"contributionSummary": "object"
}
],
"componentId": "integer (int64)",
"ballotCandidatesIndex": "object",
"candidatesNumber": "integer (int32)"
}
CampaignTransfer: object
- campaignId: integer (int64)
- title: string
- shortname: string
- goal: string
- url: string
- uuid: string (uuid)
- listed: boolean
- currentBallot: string (uuid)
- cover: ResourceTransfer
- components: ComponentTransfer
- transientComponents: ComponentTransfer
- configs: ConfigTransfer
- themes: ThemeTransfer
- workingGroups: WorkingGroupTransfer
- assemblies: integer[]
- ballots: Ballot
- existingComponents: ComponentTransfer
- existingConfigs: ConfigTransfer
- existingThemes: ThemeTransfer
- existingWorkingGroups: WorkingGroupTransfer
- template: CampaignTemplateTransfer
- timelineEdges: CampaignTimelineEdgeTransfer
Example
{
"campaignId": "integer (int64)",
"title": "string",
"shortname": "string",
"goal": "string",
"url": "string",
"uuid": "string (uuid)",
"listed": "boolean",
"currentBallot": "string (uuid)",
"cover": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
},
"components": [
{
"componentId": "integer (int64)",
"title": "string",
"description": "string",
"key": "string",
"startDate": "string (date-time)",
"endDate": "string (date-time)",
"uuid": "string (uuid)",
"position": "integer (int32)",
"timeline": "integer (int32)",
"linked": "boolean",
"milestones": [
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
],
"deletedMilestones": [
{
"componentMilestoneId": "integer (int64)",
"title": "string",
"position": "integer (int32)",
"description": "string",
"key": "string",
"type": "string",
"start": "string (date-time)",
"date": "string (date-time)",
"days": "integer (int32)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"mainContributionType": "string"
}
],
"contributions": [
{
"contributionId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"title": "string",
"text": "string",
"type": "string",
"textIndex": "string",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"budget": "string",
"authors": [
"object"
],
"workingGroupAuthors": [
null
]
}
]
}
]
}
ThemeTransfer: object
- title: string
- description: string
Example
{
"title": "string",
"description": "string"
}
WorkingGroup: object
Model reprensenting Working Groups within an Assembly
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- groupId: integer (int64)
- uuid: string (uuid)
- name: string
- text: string
- listed: boolean
- isTopic: boolean
- majorityThreshold: string
- blockMajority: boolean
- consensusBallot: string (uuid)
- consensusBallotAsString: string
- creator: User
- profile: WorkingGroupProfile
- invitationEmail: string
- invitations: InvitationTransfer
- proposals: Contribution
- ballots: Ballot
- forumResourceSpaceId: integer (int64)
- resourcesResourceSpaceId: integer (int64)
- assemblies: integer[]
- campaigns: integer[]
- locations: Location
- configs: Config
- forumResourceSpaceUUID: string
- themes: Theme
- managementType: string OPEN, COORDINATED, MODERATED, COORDINATED_AND_MODERATED, DEMOCRATIC
- forumPosts: Contribution
- resourcesResourceSpaceUUID: string
- supportedMembership: string OPEN, INVITATION, REQUEST, INVITATION_AND_REQUEST
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"isTopic": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"consensusBallot": "string (uuid)",
"consensusBallotAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string",
"name": "string",
"username": "string",
"language": "string",
"emailVerified": "boolean",
"profilePic": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"urlAsString": "string",
"creator": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
}
}
}
}
}
}
InvitationTransfer: object
- email: string
- moderator: boolean
- coordinator: boolean
- targetId: integer (int64)
- targetType: string
- invitationEmail: string
Example
{
"email": "string",
"moderator": "boolean",
"coordinator": "boolean",
"targetId": "integer (int64)",
"targetType": "string",
"invitationEmail": "string"
}
CampaignTemplate: object
A template for a campaign is composed by specified component definitions that can be used to instantiate a campaign of a certain type
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- campaignTemplateId: integer (int64)
- nameKey: string PARTICIPATORY_BUDGETING, OCCUPY_ACTION, AWARENESS_RAISING, ACTION_PROMOTION, MOBILIZATION, FUNDRAISING, PROPOSAL_MAKING
- name: string
- defComponents: ComponentDefinition
- reqConfigs: CampaignRequiredConfiguration
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"campaignTemplateId": "integer (int64)",
"nameKey": "string",
"name": "string",
"defComponents": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)"
}
}
]
}
}
]
}
}
]
}
}
]
}
]
}
NonMemberAuthor: object
Author of contributions who are not users of the platform
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- id: integer (int64)
- uuid: string (uuid)
- name: string
- email: string
- url: string (url)
- gender: string
- age: integer (int32)
- source: string
- sourceUrl: string
- publishContact: boolean
- subscribed: boolean
- phone: string
- customFieldValues: CustomFieldValue
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
LinkedAssemblyTransfer: object
- assemblyId: integer (int64)
Example
{
"assemblyId": "integer (int64)"
}
PasswordChange: object
- oldPassword: string
- password: string
- repeatPassword: string
Example
{
"oldPassword": "string",
"password": "string",
"repeatPassword": "string"
}
WorkingGroupSummaryTransfer: object
- groupId: integer (int64)
- uuid: string (uuid)
- name: string
- text: string
- listed: boolean
- majorityThreshold: string
- blockMajority: boolean
- profile: WorkingGroupProfileTransfer
- existingThemes: ThemeTransfer
- resourcesResourceSpaceId: integer (int64)
- forumResourceSpaceId: integer (int64)
- resourcesResourceSpaceUUID: string
- forumResourceSpaceUUID: string
- topic: boolean
Example
{
"groupId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"text": "string",
"listed": "boolean",
"majorityThreshold": "string",
"blockMajority": "boolean",
"profile": {
"workingGroupProfileId": "integer (int64)",
"supportedMembership": "string",
"managementType": "string",
"icon": "string",
"cover": "string"
},
"existingThemes": [
{
"title": "string",
"description": "string"
}
],
"resourcesResourceSpaceId": "integer (int64)",
"forumResourceSpaceId": "integer (int64)",
"resourcesResourceSpaceUUID": "string",
"forumResourceSpaceUUID": "string",
"topic": "boolean"
}
TransferResponseStatus: object
Response Model used for ERRORS in the API
- responseStatus: string BADREQUEST, UNAUTHORIZED, SERVERERROR, NOTAVAILABLE, NODATA, OK
-
Status of the request
- responseMessage: string
-
Message explaining the response
- errorTrace: string
-
Error trace for more details (if there is an error trace)
- newResourceId: integer (int64)
-
If the status is OK and a new resource was created, this will indicate the new resource ID
- newResourceUrl: integer (int64)
-
If the status is OK and a new resource was created, this will indicate the new resource URL
- newResourceUuid: string (uuid)
-
If the status is OK and a new resource was created, this will indicate the new resource Universal ID
Example
{
"responseStatus": "string",
"responseMessage": "string",
"errorTrace": "string",
"newResourceId": "integer (int64)",
"newResourceUrl": "integer (int64)",
"newResourceUuid": "string (uuid)"
}
FrontEndError: object
- user: string
- path: string
- message: string
Example
{
"user": "string",
"path": "string",
"message": "string"
}
Theme: object
A Theme represents a top level categorization information
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- themeId: integer (int64)
- title: string
- description: string
- icon: string
- cover: string
- type: string OFFICIAL_PRE_DEFINED, OFFICIAL, EMERGENT
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"themeId": "integer (int64)",
"title": "string",
"description": "string",
"icon": "string",
"cover": "string",
"type": "string"
}
AppCivistBaseModel: object
AppCivist base data model
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- id: integer (int64)
- read: boolean
- signal: NotificationEventSignal
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"read": "boolean",
"signal": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"spaceType": "string",
"signalType": "string",
"eventId": "string",
"title": "string",
"text": "string",
"data": "object"
}
}
LocationTransfer: object
- locationId: integer (int64)
- street: string
- city: string
- state: string
- zip: string
- country: string
- geoJson: string
Example
{
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
}
ContributionStatistics: object
Summarizes basic statistics on a contribution
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- ups: integer (int64)
- downs: integer (int64)
- favs: integer (int64)
- flags: integer (int64)
- points: integer (int64)
- averageBenefit: integer (int32)
- averageNeed: integer (int32)
- averageFeasibility: integer (int32)
- eligibilityTrue: integer (int32)
- eligibilityFalse: integer (int32)
- type: string
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"ups": "integer (int64)",
"downs": "integer (int64)",
"favs": "integer (int64)",
"flags": "integer (int64)",
"points": "integer (int64)",
"averageBenefit": "integer (int32)",
"averageNeed": "integer (int32)",
"averageFeasibility": "integer (int32)",
"eligibilityTrue": "integer (int32)",
"eligibilityFalse": "integer (int32)",
"type": "string"
}
ContributionHistoryAssociationChange: object
- resourceSpaceId: integer (int64)
- type: string ASSEMBLY, CAMPAIGN, WORKING_GROUP, COMPONENT, CONTRIBUTION, VOTING_BALLOT
- changeType: string ADDED, DELETED
Example
{
"resourceSpaceId": "integer (int64)",
"type": "string",
"changeType": "string"
}
CustomFieldValueOption: object
Model reprensenting Custom field value option
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- customFieldValueOptionId: integer (int64)
- uuid: string (uuid)
- valueType: string
- value: string
- name: string
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
NotificationEventSignal: object
A notification event signal is a single notification that is signaled (i.e., sent) to users who have subscribed to the event name in the resource space
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- id: integer (int64)
- spaceType: string ASSEMBLY, CAMPAIGN, WORKING_GROUP, COMPONENT, CONTRIBUTION, VOTING_BALLOT
- signalType: string REGULAR, NEWSLETTER
- eventId: string NEW_CAMPAIGN, NEW_WORKING_GROUP, NEW_VOTING_BALLOT, NEW_MILESTONE, NEW_CONTRIBUTION_IDEA, NEW_CONTRIBUTION_PROPOSAL, NEW_CONTRIBUTION_DISCUSSION, NEW_CONTRIBUTION_COMMENT, NEW_CONTRIBUTION_NOTE, NEW_CONTRIBUTION_FORUM_POST, NEW_CONTRIBUTION_FEEDBACK, NEW_CONTRIBUTION_ISSUE, UPDATED_ASSEMBLY, UPDATED_CAMPAIGN, UPDATED_WORKING_GROUP, UPDATED_VOTING_BALLOT, UPDATED_MILESTONE, UPDATED_CONTRIBUTION_IDEA, UPDATED_CONTRIBUTION_PROPOSAL, UPDATED_CONTRIBUTION_DISCUSSION, UPDATED_CONTRIBUTION_COMMENT, UPDATED_CONTRIBUTION_NOTE, UPDATED_CONTRIBUTION_FORUM_POST, UPDATED_CONTRIBUTION_FEEDBACK, UPDATED_CONTRIBUTION_HISTORY, MILESTONE_PASSED, MILESTONE_UPCOMING, MILESTONE_UPCOMING_IN_A_WEEK, MILESTONE_UPCOMING_IN_A_DAY, BALLOT_UPCOMING_IN_A_DAY, BALLOT_UPCOMING_IN_A_WEEK, BALLOT_UPCOMING_IN_A_MONTH, BALLOT_ENDING_IN_A_DAY, BALLOT_ENDING_IN_A_WEEK, BALLOT_ENDING_IN_A_MONTH, UPDATED_ASSEMBLY_CONFIGS, UPDATED_CAMPAIGN_CONFIGS, UPDATED_WORKING_GROUP_CONFIGS, MEMBER_JOINED, DELETED_CONTRIBUTION, MODERATED_CONTRIBUTION, NEW_CONTRIBUTION_FEEDBACK_FLAG, NEWSLETTER
- title: string
- text: string
- data: object
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"spaceType": "string",
"signalType": "string",
"eventId": "string",
"title": "string",
"text": "string",
"data": "object"
}
OrganizationTransfer: object
- organizationId: integer (int64)
- title: string
- description: string
- logo: ResourceTransfer
Example
{
"organizationId": "integer (int64)",
"title": "string",
"description": "string",
"logo": {
"resourceId": "integer (int64)",
"uuid": "string (uuid)",
"url": "string (url)",
"creator": "object",
"location": {
"locationId": "integer (int64)",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string"
},
"resourceType": "string",
"name": "string",
"padId": "string",
"readOnlyPadId": "string",
"resourceSpaceWithServerConfigs": "string (uuid)",
"urlLarge": "string (url)",
"urlMedium": "string (url)",
"urlThumbnail": "string (url)"
}
}
Contribution: object
Generic model for citizen contributions. A contribuiton represents IDEAS, PROPOSALS, DISCUSSION, COMMENTS, NOTES, ISSUES, ETC.
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- contributionId: integer (int64)
-
Contribution numerical ID
- source: string
- sourceUrl: string
- location: Location
- nonMemberAuthors: NonMemberAuthor
- budget: string
- authors: User
-
List of authors when is more then one but not a working group
- popularity: integer (int32)
- commentCount: integer (int32)
- forumCommentCount: integer (int32)
- totalComments: integer (int32)
- pinned: boolean
- firstAuthor: User
-
Read only property displaying the first information
- firstAuthorName: string
-
Read only property displaying the first author name
- assemblyId: integer (int64)
-
Read only property displaying the Assembly where this Contribution was created
- workingGroupAuthors: WorkingGroup
-
Working Groups to which this Contribution is associated
- forum: ResourceSpace
- stats: ContributionStatistics
- themes: Theme
- attachments: Resource
- hashtags: Hashtag
- associatedMilestones: ComponentMilestone
- assignToContributions: integer[]
- actionDueDate: string (date-time)
- actionDone: boolean
- action: string
- assessmentSummary: string
- extendedTextPad: Resource
- cover: Resource
- publicRevision: integer (int32)
- sourceCode: string
- assessments: Contribution
- officialThemes: Theme
- emergentThemes: Theme
- document: string
- campaignIds: integer[]
- containingContributionsIds: integer[]
- campaignUuids: string[]
- workingGroups: WorkingGroup
- resourceSpaceId: integer (int64)
- resourceSpaceUUID: string (uuid)
- forumResourceSpaceId: integer (int64)
- forumResourceSpaceUUID: string (uuid)
- readOnlyPadUrl: string
- uuid: string (uuid)
-
Contribution Universal ID (meant to be valid accross intances of the platform)
- title: string
-
Title of the contribution
- text: string
-
Text describing the contribution
- plainText: string
-
Text describing the contribution, in plain text format
- type: string ISSUE, QUESTION, IDEA, COMMENT, PROPOSAL, ASSESSMENT, FORUM_POST, ACTION_ITEM, DISCUSSION, BRAINSTORMING, DELIBERATIVE_DISCUSSION, NOTE
-
Type of Contribution
- status: string DRAFT, NEW, PUBLISHED, EXCLUDED, ARCHIVED, MODERATED, INBALLOT, SELECTED
-
Status of the Contribution (e.g., new, in progress, published, etc.)
- moderationComment: string
-
Comment explaining why a contribution is moderated (e.g., deleted, changed status, etc.)
- nonMemberAuthor: NonMemberAuthor
-
Author associated to the contribution when it is not an AppCivist User
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"contributionId": "integer (int64)",
"source": "string",
"sourceUrl": "string",
"location": {
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
},
"nonMemberAuthors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"id": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"email": "string",
"url": "string (url)",
"gender": "string",
"age": "integer (int32)",
"source": "string",
"sourceUrl": "string",
"publishContact": "boolean",
"subscribed": "boolean",
"phone": "string",
"customFieldValues": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueId": "integer (int64)",
"uuid": "string (uuid)",
"entityTargetType": "string",
"entityTargetUuid": "string (uuid)",
"value": "string",
"customFieldDefinition": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldDefinitionId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"entityType": "string",
"entityFilterAttributeName": "string",
"entityFilter": "string",
"fieldType": "string",
"position": "integer (int32)",
"limit": "string",
"limitType": "string",
"customFieldValueOptions": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"customFieldValueOptionId": "integer (int64)",
"uuid": "string (uuid)",
"valueType": "string",
"value": "string",
"name": "string"
}
]
}
}
]
}
],
"budget": "string",
"authors": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"userId": "integer (int64)",
"uuid": "string (uuid)",
"uuidAsString": "string",
"email": "string"
}
]
}
Location: object
- locationId: integer (int64)
- placeName: string
- street: string
- city: string
- state: string
- zip: string
- country: string
- geoJson: string
- bestCoordinates: integer (int32)
- source: string
- markedForReview: boolean
- additionInfo: string
Example
{
"locationId": "integer (int64)",
"placeName": "string",
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"geoJson": "string",
"bestCoordinates": "integer (int32)",
"source": "string",
"markedForReview": "boolean",
"additionInfo": "string"
}
ComponentDefinition: object
Definition of a component that can be used to create a workflow of a campaign.
- creation: string (date-time)
-
Date in which this resource was created
- lastUpdate: string (date-time)
-
Date in which this resource was last updated
- lang: string
-
Language of the content in this resource
- removal: string (date-time)
-
Date in which this resource was removed
- removed: boolean
-
Indicates if this resource is logically deleted
- componentDefId: integer (int64)
- uuid: string (uuid)
- name: string
- description: string
- uuidAsString: string
- requiredConfigurations: ComponentRequiredConfiguration
- requiredMilestones: ComponentRequiredMilestone
Example
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentRequiredConfigurationId": "integer (int64)",
"componentDef": {
"creation": "string (date-time)",
"lastUpdate": "string (date-time)",
"lang": "string",
"removal": "string (date-time)",
"removed": "boolean",
"componentDefId": "integer (int64)",
"uuid": "string (uuid)",
"name": "string",
"description": "string",
"uuidAsString": "string",
"requiredConfigurations": [
{
"creation": "string (date-time)",
"lastUpdate": "string (date-time)"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}